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

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

Руководство пользователя (англ. user guide или user manual), руководство по эксплуатации, руководство оператора — документ, назначение которого — предоставить людям помощь в использовании некоторой системы. Документ входит в состав технической документации на систему и, как правило, подготавливается техническим писателем.

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

Содержание

Содержание

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

  • Аннотацию, в которой приводится краткое изложение содержимого документа и его назначение
  • Введение, содержащее ссылки на связанные документы и информацию о том, как лучше всего использовать данное руководство
  • Страницу содержания
  • Главы, описывающие, как использовать, по крайней мере, наиболее важные функции системы
  • Глава, описывающая возможные проблемы и пути их решения
  • Часто задаваемые вопросы и ответы на них
  • Где ещё найти информацию по предмету, контактная информация
  • Глоссарий и, в больших документах, предметный указатель

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

Стандарты

Структура и содержание документа Руководство пользователя автоматизированной системы регламентированы подразделом 3.4 документа РД 50-34.698-90. Структура и содержание документов Руководство оператора, Руководство программиста, Руководство системного программиста регламентированы ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 соответственно.

  • Комплекс стандартов и руководящих документов на автоматизированные системы (ГОСТ 34)
    • РД 50-34.698-90 АВТОМАТИЗИРОВАННЫЕ СИСТЕМЫ. ТРЕБОВАНИЯ К СОДЕРЖАНИЮ ДОКУМЕНТОВ
  • Единая система конструкторской документации (ЕСКД) определяет документ «Руководство по эксплуатации» и другие документы:
    • ГОСТ 2.601-2006 Эксплуатационные документы
    • ГОСТ 2.610-2006 Правила выполнения эксплуатационных документов
  • Единая система программной документации (ЕСПД) определяет документы «Руководство оператора», «Руководство по техническому обслуживанию» и их структуру:
    • ГОСТ 19.101-77 Виды программ и программных документов
    • ГОСТ 19.105-78 Общие требования к программным документам
    • ГОСТ 19.505-79 Руководство оператора. Требования к содержанию и оформлению
    • ГОСТ 19.508-79 Руководство по техническому обслуживанию. Требования к содержанию и оформлению

См. также

Ссылки


Wikimedia Foundation. 2010.

Игры ⚽ Нужно решить контрольную?

Полезное


Смотреть что такое "Руководство пользователя" в других словарях:

  • руководство пользователя — сущ., кол во синонимов: 4 • инструкция (28) • мануалка (5) • паспорт (17) • …   Словарь синонимов

  • руководство пользователя — — [Е.С.Алексеев, А.А.Мячев. Англо русский толковый словарь по системотехнике ЭВМ. Москва 1993] Тематики информационные технологии в целом EN user guidemanual …   Справочник технического переводчика

  • руководство пользователя — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… …   Automatikos terminų žodynas

  • руководство пользователя по аккредитации и подаче заявок на Олимпийские игры — [Департамент лингвистических услуг Оргкомитета «Сочи 2014». Глоссарий терминов] Тематики спорт (службы Игр) EN accreditation and entries at the Olympic Games users guide …   Справочник технического переводчика

  • Руководство — Руководство: Руководство  контроль поведения других людей (см. Власть). Руководство  набор правил для осуществления или использования чего либо (см. Инструкция). См. также Руководство пользователя Организационное руководство Руководство …   Википедия

  • руководство для пользователя — — [А.С.Гольдберг. Англо русский энергетический словарь. 2006 г.] Тематики энергетика в целом EN user directory …   Справочник технического переводчика

  • руководство для пользователя — vartotojo instrukcija statusas T sritis automatika atitikmenys: angl. user guide; user manual vok. Benutzeranleitung, f; Benutzerhandbuch, n rus. руководство для пользователя, n pranc. notice de présentation, f …   Automatikos terminų žodynas

  • РУКОВОДСТВО ПО РАЗРАБОТКЕ БЮДЖЕТА — BUDGET MANUALРазработка бюджета может быть упрощена до определенной степени, если у фирмы имеется руководство по разработке бюджета, к рое документирует процедуру разработки и определяет основные направления, к рым необходимо следовать на… …   Энциклопедия банковского дела и финансов

  • справочник пользователя — vartotojo žinynas statusas T sritis automatika atitikmenys: angl. user directory; user guide; user manual vok. Bedienungsanleitung, f; Benutzerauskunftsdatei, f; Benutzerhandbuch, n rus. руководство пользователя, n; справочник пользователя, m… …   Automatikos terminų žodynas

  • Р 50.1.041-2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации-пользователя — Терминология Р 50.1.041 2002: Информационные технологии. Руководство по проектированию профилей среды открытой системы (СОС) организации пользователя: 3.1.1 аккредитованная организация разработчик стандартов (accredited standards development… …   Словарь-справочник терминов нормативно-технической документации


Поделиться ссылкой на выделенное

Прямая ссылка:
Нажмите правой клавишей мыши и выберите «Копировать ссылку»