Что такое пользовательская документация и зачем она нужна? ( | BA GIRL | Бизнес-аналитик в IT
Что такое пользовательская документация и зачем она нужна?
(38 секунд)
Пользовательская документация – это документ или набор документов, который готовится на этапе завершения проекта или завершения работ по разработке функциональности и содержит в себе подробную информацию о разработанном функционале.
На практике, пользовательская документация, также как и множество других документов, не имеет четко стандартизованного вида. Темплейт пользовательской документации разрабатывается или для всей компании в целом, или конкретно для проекта.
Как правило, в продуктовых компаниях на проектах используется темплейт общий для всей компании без модификаций, а в аутсорс компаниях общий темплейт модифицируется под разные проекты или вообще разрабатывается отдельно.
Содержание информации в пользовательской документации и ее объем будет также очень сильно отличаться в разных компаниях и проектах и может также зависить от контракта. При этом есть более менее общепринятое понимание, какие подходы могут быть использованы при разработке пользовательской документации.
Подходы к разработке пользовательской документации:
1. Вводное руководство.
Как правило, вводное руководство содержит в себе пошаговое описание выполнения типовых задач и ожидаемые результаты. Обычно его разрабатывают для новых пользователей системы, которые с ней никогда не работали.
2. Тематический подход.
Документация при таком подходе тоже содержит описание выполнения задач, при этом сама информация разделена по определенным темам, а не по конкретным задачам пользователей. Такой подход часто используют при подготовке пользовательской документации для многомодульных систем.
3. Организация документации в виде алфавитного справочника.
Обычно такой способ организации используется при подготовке документации для различных служб тех.поддержки, которые достаточно хорошо знают систему и понимают, что именно им нужно искать.
Помимо этого, пользовательская документация может быть организована не только в документах, но и непосредственно в виде help модуля в самой системе.
Как вы уже, наверное, обратили внимание, когда мы говорим о пользовательской документации, то мы не имеем ввиду документацию ТОЛЬКО для конечного пользователя функциональности системы.
Мы также можем говорить об отдельных частях документации (или даже об отдельных пакетах документов) для администрирования системы или для служб технической поддержки, что приводит нас к пониманию, что и уровень формализации и детальности информации в пользовательской документации для разных групп пользователей будет значительно отличаться.
Приходилось ли вам писать пользовательскую документацию? С какими сложностями сталкивались?
