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