Разработчик порой забывает, что важно не только создать программный продукт, но и составить сопутствующую документацию. В список необходимых документов входит руководство пользователя. Разберёмся, для чего нужен этот документ и как его составить?
Руководство пользователя – это эксплуатационный документ, который помогает людям пользоваться программным обеспечением или автоматизированной системой. Качественно составленное руководство повышает лояльность пользователя. Если при эксплуатации продукта возникли проблемы, хорошее руководство позволит быстро найти ответ без необходимости обращения в техническую поддержку.
Алгоритм составления руководства пользователя:
- ознакомление с требованиями к документу;
- определение целевой аудитории;
- составление шаблона;
- ознакомление с исходными данными и, при необходимости, запрос недостающей информации;
- заполнение шаблона на основе полученных данных;
- финальная вычитка.
Требования к руководству предъявляет заказчик (разработчик) в зависимости от того, где документация будет использована. Руководство может входить в комплект документации для подачи в Единый реестр российских программ для ЭВМ и БД. В таком случае заказчик попросит при подготовке опираться на требования 19 или 34 серии ГОСТов. Также руководство может предназначаться для использования внутри компании. В данном случае требования могут быть более лояльными.
Следующий этап – определение целевой аудитории. Технический писатель должен понимать, кто будет читать документ и какой уровень знаний у будущего читателя. Руководство следует составлять на понятном для пользователя языке.
Важно также продумать структуру будущего документа. Для разработки шаблона руководства на автоматизированную систему можно обратиться к требованиям ГОСТ Р 59795-2021. Стоит отметить, что понятие «руководство пользователя» встречается только в 34 серии ГОСТов. При необходимости составления документа по требованиям ЕСПД следует обращаться к ГОСТ 19.503-79 (для руководства системного программиста), ГОСТ 19.504-79 (для руководства программиста) и ГОСТ 19.505-79 (для руководства оператора). В таком случае выбор структуры будет зависеть от роли пользователя и операций, которые он выполняет в отношении ПО.
Чаще всего руководство пользователя состоит из следующих разделов:
- вводная конструкция (аннотация или введение);
- содержание;
- назначение и условия применения;
- подготовка к работе;
- описание основных операций;
- сообщения об ошибках или аварийных ситуациях.
Также можно указать перечень использованных терминов и сокращений, описать интерфейс продукта, указать контактную информацию технической поддержки. Если документация будет распространена в электронном виде, в руководство пользователя можно также включить видеоинструкции и интерактивные элементы.
Наиболее сложный этап составления документации – анализ исходных данных. В некоторых компаниях предусмотрена должность аналитика, который помогает техническому писателю переработать исходный материал. Если аналитика нет, то необходимо углубиться в специфику описываемого продукта, пообщаться с разработчиком, иногда даже протестировать интерфейс.
Далее на основе полученных данных следует заполнить шаблон. Текст разделов должен быть безэмоциональным и информативным. При употреблении терминов и сокращений их необходимо выносить в отдельный раздел с описанием их значения.
Финальный этап составления руководства пользователя – вычитка подготовленного текста. Зачастую про документацию вспоминают в последний момент. Времени на проверку текста остаётся немного, но этот этап не стоит недооценивать. В тексте документа недопустимы грамматические, синтаксические, орфографические и стилистические ошибки.
Качественная документация позволяет пользователю разбираться в программном продукте. Заказчик экономит время на оказание технической поддержки, которое может потратить на разработку и продвижение новых идей.