Комментарии 4
кстати да, надо как-нибудь, всё-таки, почитать хоть где-нибудь юзерз гуайд, а то либо всё опытным путем, либо уже отдельный учебник, или даже несколько…
Как показала практика, лучше инструкции для пользователя выходят в формате faq, который упорядочен. А-ля
— как мне запустить систему?
— как мне открыть смену?
— как добавить товар в чек?
— как пробить чек?
И тп.
Обязательно писать вместе с тестировщиками/бета-тестерами.
— как мне запустить систему?
— как мне открыть смену?
— как добавить товар в чек?
— как пробить чек?
И тп.
Обязательно писать вместе с тестировщиками/бета-тестерами.
Хорошая статья. Дополню из личного опыта.
1. Ведем документацию на движке MediaWiki. Помимо описанных четырех типов топиков используем топики-агрегаторы. В них собираются ссылки по конкретной теме. Такой подход помогает переместиться практически в любое место за пару кликов.
2. По поводу привлечения внимания. «Важно» и «Внимание» объединили в один термин, т. к. они выполняют одну и ту же функцию. Добавили «Совет» — какие-то необязательные детали, которые упрощают работу пользователя.
1. Ведем документацию на движке MediaWiki. Помимо описанных четырех типов топиков используем топики-агрегаторы. В них собираются ссылки по конкретной теме. Такой подход помогает переместиться практически в любое место за пару кликов.
2. По поводу привлечения внимания. «Важно» и «Внимание» объединили в один термин, т. к. они выполняют одну и ту же функцию. Добавили «Совет» — какие-то необязательные детали, которые упрощают работу пользователя.
Зарегистрируйтесь на Хабре, чтобы оставить комментарий
Вредные советы: как правильно писать техническую документацию?