Гид пользователя - User guide

Не путать с Руководство по эксплуатации.

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

Руководства пользователя чаще всего связаны с электронными товарами, компьютерное железо и программного обеспечения, хотя их можно написать для любого продукта.[3]

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

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

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

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

История

Руководство пользователя выгравировано на модели антикиферского механизма.

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

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

  • длина и трудности чтения[5]
  • роль печатных руководств пользователя для цифровых программ[6]
  • ориентированный на пользователя дизайн[6]

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

Руководства пользователя и руководства для самых нетривиальных программные приложения представляют собой книжные документы с содержанием, аналогичным приведенному выше списку. Они могут распространяться как в печатном, так и в электронном виде. Некоторые документы имеют более гибкую структуру с множеством внутренних ссылок. В Гугл Земля Гид пользователя[7] является примером этого формата. Период, термин гид часто применяется к документу, касающемуся определенного аспекта программного продукта. Некоторые обычаи Установка Гид, Руководство по началу работы, и различные Как гиды. Примером может служить Picasa Руководство по началу работы.[8]

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

Электронные руководства и руководства для потребителей

Необходимость в руководстве для каждого электронного устройства является одним из прав и потребностей всех владельцев электронных устройств, включая смартфоны, ноутбуки, бытовую технику и т. Д.[10] это веб-сайт, на котором можно найти руководства по эксплуатации различных электронных устройств.

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

Рекомендации

  1. ^ «Написание технической документации в Интернете: руководства пользователя». [email protected]. Получено 13 августа 2009.
  2. ^ Гэри Блейк и Роберт В. Блай, Элементы технического письма, стр. 143. Нью-Йорк: Macmillan Publishers, 1993. ISBN  0020130856
  3. ^ "Руководства Brain - все полезные руководства в одном месте!". manualsbrain.com. Получено 2017-08-15.
  4. ^ "Боффинс расшифровывает руководство для древнегреческого компьютера 2000-летней давности". Получено 2018-11-29.
  5. ^ а б c Чафин, Рой (январь 1982). «Руководства пользователя: что действительно нужно пользователю?». SIGDOC '82 Труды 1-й ежегодной международной конференции по системной документации: 36–39 - через цифровую библиотеку ACM.
  6. ^ а б Макки, Джон (август 1986). «Руководства пользователя компьютеров в печати: есть ли у них будущее?». ACM SIGDOC Asterisk Journal компьютерной документации. 12: 11–16 - через цифровую библиотеку ACM.
  7. ^ "Руководство пользователя Google Планета Земля". Google. 4 июня 2009 г.. Получено 13 августа 2009.
  8. ^ «Начало работы с Picasa: руководство по началу работы». Google. 15 июня 2009 г.. Получено 13 августа 2009.
  9. ^ «Справка по Autodesk Topobase 2010». Autodesk. Получено 13 августа 2009.
  10. ^ "Ручные устройства - Хранилище руководств пользователя".