Наполнение

Как писать руководство пользователя? Часть II - обобщенная структура по ГОСТ 19.ххх, IEEE Std 1063-2001 и пример наполнения содержимым

Как писать руководство пользователя? Часть II

Обобщенная структура руководства пользователя программы на основе ГОСТов 19-й системы, IEEE Std 1063-2001 и с учетом рекомендаций «манифеста Кагарлицкого», установлена степень опциональности разделов руководства в зависимости от того, кому поставляется программа, частично заполнены разделы и подразделы руководства. Редакция от 20.06.2018.

Концептуальная модель информационного наполнения (conceptual content model) по ГОСТ Р ИСО 9241-151-2014

Концептуальная модель информационного наполнения (conceptual content model) по ГОСТ Р ИСО 9241-151-2014

Абстрактная модель, описывающая понятия области прил., отношения между этими понятиями и операции, которые выполняются на основе этих понятий или отношений [из п. 3.3 ГОСТ Р ИСО 9241-151-2014]

Объект информационного наполнения (content object) по ГОСТ Р ИСО 9241-151-2014

Объект информационного наполнения (content object) по ГОСТ Р ИСО 9241-151-2014

Интерактивный или неинтерактивный объект, содержащий информацию, представленную в виде текста, изображения, видео- или звуковыми материалами либо другими типами носителей [из п. 3.5 ГОСТ Р ИСО 9241-151-2014]

Требования к написанию инструкций [из п. 8.2.5 ГОСТ Р 58049-2017]

При написании инструкций рекомендуется составлять короткие предложения (максимум 20 слов). Примечание - При подсчете слов для определения длины предложения применяются следующие допущения:

  • текст в скобках считается новым предложением;
  • числовые значения считаются как одно слово;
  • буквенно-цифровой идентификатор считается за отдельное слово;
  • аббревиатура считается за отдельное слово;
  • названия, предупредительные надписи и цитируемый текст считаются за одно слово.

[из пп. 8.2.5.1 ГОСТ Р 58049-2017]

В одном предложении рекомендуется описывать только одну команду. Описание более одной команды в предложении возможно только в случае, когда описываемые действия производятся одновременно [из пп. 8.2.5.2 ГОСТ Р 58049-2017]

В инструкции необходимо использовать глаголы в повелительном наклонении во множественном числе. Пример

Исходный текст

Текст, отредактированный согласно правилам УТР

После приземления и остановки самолета, находящегося в аварийном состоянии, необходимо выполнять команды командира экипажа

После аварийного приземления и остановки самолета выполняйте команды командира экипажа

[из пп. 8.2.5.3 ГОСТ Р 58049-2017]

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

Исходный текст

Текст, отредактированный согласно правилам УТР

Неисправную батарею, подготовленную к ремонту, необходимо поставить на верстак. Существует два способа для разьединения неисправного элемента

Подготовленную к ремонту батарею ставят на верстак. Разъединение неисправного элемента производят двумя способами

[из пп. 8.2.5.4 ГОСТ Р 58049-2017]

«Техническая документация»

Связь по эл. почте admin @ tdocs . su (без пробелов), тел. 8-910-468-09-28 или в форме Контакты.

Copyright © «Техническая документация» 2008. Заимствуйте наши материалы с блеском! При воспроизведении материалов портала обязательна установка активной гиперссылки на источник — страницу с этой публикацией на tdocs.su.

Яндекс.Метрика