Главная
E-mail
Карта сайта
Руководство по эксплуатации
Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.
Большинство руководств пользователя помимо текстовых описаний содержит изображения. В случае программного обеспечения, в руководство обычно включаются снимки экрана, при описании аппаратуры — простые и понятные рисунки или фотографии. Используется стиль и язык, доступный предполагаемой аудитории, использование жаргона сокращается до минимума либо подробно объясняется.
Содержание
Типичное руководство пользователя содержит:
- Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение.
- Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство.
- Страницу содержания.
- Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы.
- Глава, описывающая возможные проблемы и пути их решения.
- Часто задаваемые вопросы и ответы на них.
- Где ещё найти информацию по предмету, контактная информация.
- Глоссарий и, в больших документах, предметный указатель.
Стандарты
Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.
- Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34):
— РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ;
-
Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:
— ГОСТ 2.601-2006 Эксплуатационные документы; -
Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:
— ГОСТ 19.101-77 Виды программ и программных документов;
— ГОСТ 19.105-78 Общие требования к программным документам;
— ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению;
— ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению.
