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

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

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

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

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

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

История

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

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

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

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

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

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

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

См. также

Ссылки

^ «Боффинс расшифровывает руководство к древнегреческому компьютеру возрастом 2000 лет» . Проверено 29 ноября 2018 г.
^ Jump up to: ^а ^б ^с Чафин, Рой (январь 1982 г.). «Руководства пользователя: что действительно нужно пользователю?». Материалы 1-й ежегодной международной конференции по системной документации - SIGDOC '82 . стр. 36–39. дои : 10.1145/800065.801307 . ISBN 089791080X . S2CID 6435788 .
^ Jump up to: ^а ^б Макки, Джон (август 1986 г.). «Печатные руководства пользователя компьютера: есть ли у них будущее?». ACM SIGDOC Asterisk Журнал компьютерной документации . 12 (2): 11–16. дои : 10.1145/15505.15507 . S2CID 35615987 .
^ «Руководство пользователя Google Планета Земля» . 4 июня 2009 года . Проверено 13 августа 2009 г.
^ «Начало работы с Picasa: Руководство по началу работы» . 15 июня 2009 года . Проверено 13 августа 2009 г.
^ «Справка Autodesk Topobase 2010» . Автодеск . Проверено 13 августа 2009 г.

[1] «Боффинс расшифровывает руководство к древнегреческому компьютеру возрастом 2000 лет» . Проверено 29 ноября 2018 г.

[:0-2] Jump up to: ^а ^б ^с Чафин, Рой (январь 1982 г.). «Руководства пользователя: что действительно нужно пользователю?». Материалы 1-й ежегодной международной конференции по системной документации - SIGDOC '82 . стр. 36–39. дои : 10.1145/800065.801307 . ISBN 089791080X . S2CID 6435788 .

[:1-3] Jump up to: ^а ^б Макки, Джон (август 1986 г.). «Печатные руководства пользователя компьютера: есть ли у них будущее?». ACM SIGDOC Asterisk Журнал компьютерной документации . 12 (2): 11–16. дои : 10.1145/15505.15507 . S2CID 35615987 .

[4] «Руководство пользователя Google Планета Земля» . 4 июня 2009 года . Проверено 13 августа 2009 г.

[5] «Начало работы с Picasa: Руководство по началу работы» . 15 июня 2009 года . Проверено 13 августа 2009 г.

[6] «Справка Autodesk Topobase 2010» . Автодеск . Проверено 13 августа 2009 г.

[ 1 ]

[ 2 ]

[ 3 ]

[ 4 ]

[ 5 ]

[ 6 ]