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

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

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

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

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

СОДЕРЖАНИЕ
  • 1 Содержание руководства пользователя
  • 2 История
  • 3 Руководства и руководства по компьютерному программному обеспечению
  • 4 См. Также
  • 5 ссылки
Содержание руководства пользователя

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

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

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

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

  • использование простого языка
  • длина и трудности чтения
  • роль печатных руководств пользователя для цифровых программ
  • ориентированный на пользователя дизайн
Руководства и руководства по компьютерному программному обеспечению

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

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

Смотрите также
использованная литература
Последняя правка сделана 2023-03-20 06:31:33
Содержание доступно по лицензии CC BY-SA 3.0 (если не указано иное).
Обратная связь: support@alphapedia.ru
Соглашение
О проекте