Самое лучшее и популярное программное обеспечение не будет приносить прибыль, если потенциальные пользователи не будут знать, как правильно им пользоваться. Любое ПО, которое попадает в эксплуатацию, должно подкрепляться специальными техническими документами, где будет детально расписано, как им необходимо пользоваться и с какой целью. К таким данным и относят техническое руководство и руководство по эксплуатации.
Обычно пользовательское и техническое руководство создаются техническим специалистом, который имеет опыт в составлении подобных материалов и может посмотреть на продукт со стороны рядового пользователя, для которого такой продукт и разрабатывался.
Из чего структурно должно состоять руководство пользователя
Традиционно подобный документ включает в себя:
- Наименование и пояснение всех авторских прав;
- Небольшое предисловие, в котором описаны рекомендации по использованию ПО и содержание;
- Руководство по использованию наиболее актуальных функциональностей системы;
- Раздел с пояснениями ошибок (так называемые troubleshooting), в котором содержатся базовые проблемы и пути их решения.
Порой руководство может содержать блок наиболее часто задаваемых вопрос (FAQ), контакты обратной связи, блок терминологии и перечень всевозможных дополнительных материалов.
Как правильно создавать руководство пользователя
Технические специалисты, во время работы над созданием руководства пользователя, должны брать в расчет один из трёх способов по реализации подобного документа. А именно:
- Руководство — детализированное и пошаговое описание типичных свойств ПО. Данный вариант изложения хорошо подходит для начинающих пользователей, которые впервые знакомятся с работоспособностью продукта.
- Тематическая информация — документ, разбитый на главы, где каждый раздел содержит детальное описание функционала.
- Данные, предоставлены в алфавитном порядке — выступают в роли вспомогательного материала поиска информации для опытных пользователей, дабы как можно быстрее обновить знания или что-то вспомнить.
Беря в расчет тот факт, что все руководства в последние годы создаются в цифровом формате, в них добавляется раздел поиска, что существенным образом облегчает поиск необходимых данных.
Одно из базовых условий успешности руководства пользователя является то, чтобы оно в реальной степени могло отражать текущее состояние ПО.Порой нередки ситуации, когда для первоначальной версии продукта создается одно руководство, а во время последующей модернизации редактированием руководства никто не занимается. Подобная практика может привести к возникновению достаточно глобальной путаницы и получения негативных отзывов от пользователей.
Итоги
Все вышеперечисленное ярко свидетельствует о том, что создание технического руководства пользователей при выпуске ПО — неотъемлемая часть общего процесса создания веб-продукта. Подобные документы (физического и цифрового формата) служат хорошим источником познаний технических особенностей программного обеспечения, с которым впервые сталкиваются пользователи.
Оставить комментарий