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