Руководство пользователя

Руководство пользователя , также известное как руководство пользователя , призвано помочь пользователям в использовании определенного продукта, услуги или приложения. Обычно его пишет технический специалист, разработчик продукта или персонал службы поддержки клиентов компании.

Большинство руководств пользователя содержат как письменное руководство, так и соответствующие изображения. В случае компьютерных приложений обычно включают скриншоты интерфейса(ов) человек-машина, а руководства по оборудованию часто включают понятные, упрощенные диаграммы . Используемый язык соответствует целевой аудитории , с минимальным количеством жаргона или с подробными объяснениями.

Содержание руководства пользователя

Разделы руководства пользователя часто включают в себя:

Титульный лист
Титульный лист и страница с информацией об авторских правах
Предисловие, содержащее сведения о связанных документах и информацию о том, как ориентироваться в руководстве пользователя.
Страница содержания
Раздел «Цель». Это должен быть обзор, а не подробное описание цели документа.
Раздел «Аудитория», в котором четко указано, для какой целевой аудитории предназначена информация, включая необязательные сведения.
Раздел «Область применения» имеет решающее значение, поскольку он также служит отказом от ответственности, указывая, что выходит за рамки, а что охватывается.
Руководство по использованию хотя бы основных функций системы
Раздел по устранению неполадок, в котором подробно описаны возможные ошибки или проблемы, которые могут возникнуть, а также способы их устранения.
FAQ (часто задаваемые вопросы )
Где найти дополнительную помощь и контактные данные
Глоссарий и, для больших документов , индекс

История

Руководства пользователя были найдены вместе с древними устройствами. Одним из примеров является Антикитерский механизм ^[1] , 2000-летний греческий аналоговый компьютер, найденный у берегов греческого острова Антикитера в 1900 году. На обложке этого устройства находятся отрывки текста, описывающие особенности и работу механизма.

По мере развития индустрии программного обеспечения вопрос о том, как лучше всего документировать программы, оставался нерешенным. Это была уникальная проблема для разработчиков программного обеспечения, поскольку пользователи часто разочаровывались в текущих справочных документах. ^[2] Некоторые соображения по написанию руководства пользователя, разработанные в то время, включают:

использование простого языка ^[2]
длина и сложность чтения ^[2]
роль печатных руководств пользователя для цифровых программ ^[3]
Дизайн, ориентированный на пользователя ^[3]

Руководства и руководства по компьютерному программному обеспечению

До появления Unix , например, GCOS , документация мэйнфреймов представляла собой печатные страницы, доступные локально для пользователей (сотрудников, студентов...), организованные в стальные папки, скрепленные вместе в одной монолитной стальной стойке для чтения, прикрепленной болтами к столу или стойке, со страницами, организованными для модульных обновлений информации, замен, исправлений и дополнений. ^{[ необходима ссылка ]}

Руководства пользователя и руководства пользователя для большинства нетривиальных программных приложений ПК и браузеров представляют собой документы в виде книг с содержанием, аналогичным приведенному выше списку. Они могут распространяться как в печатном, так и в электронном виде. Некоторые документы имеют более гибкую структуру с множеством внутренних ссылок. Руководство пользователя Google Earth^[4] является примером этого формата. Термин руководство часто применяется к документу, который рассматривает определенный аспект программного продукта. Некоторые использования — Руководство по установке , Руководство по началу работы и различные руководства . Примером является Руководство по началу работы Picasa . ^[5]

В некоторых бизнес- приложениях, где группы пользователей имеют доступ только к подмножеству полной функциональности приложения, руководство пользователя может быть подготовлено для каждой группы. Примером такого подхода является документ Autodesk Topobase 2010 Help^[6] , который содержит отдельные Руководства администратора , Руководства пользователя и Руководство разработчика .

Смотрите также

Ссылки

^ "Боффины расшифровали руководство по 2000-летнему древнегреческому компьютеру" . Получено 29.11.2018 .
^ abc Чафин, Рой (январь 1982). «Руководства пользователя: что действительно нужно пользователю?». Труды 1-й ежегодной международной конференции по системной документации — SIGDOC '82 . С. 36–39. doi : 10.1145/800065.801307 . ISBN 089791080X. S2CID 6435788.
^ ab McKee, John (август 1986 г.). «Руководства пользователя компьютеров в печати: есть ли у них будущее?». ACM SIGDOC Asterisk Journal of Computer Documentation . 12 (2): 11–16. doi :10.1145/15505.15507. S2CID 35615987.
^ "Руководство пользователя Google Earth". 4 июня 2009 г. Получено 13 августа 2009 г.
^ "Начало работы с Picasa: Руководство по началу работы". 15 июня 2009 г. Получено 13 августа 2009 г.
^ "Autodesk Topobase 2010 Help". Autodesk . Получено 13 августа 2009 .