Титульный лист руководства оператора

(по ГОСТ 19.505-79. ЕСПД. Руководство оператора. Требования к содержанию и оформлению)

    Настоящий стандарт устанавливает требования к
содержанию и оформлению программного документа «Руководство
оператора», определённого ГОСТ 19.101-77. Структуру и оформление документа устанавливают в
соответствии с ГОСТ 19.105-78. 
Составление информационной части (аннотации и
содержания) является обязательным.

==================================

Скачать пример оформления

A.B.00001-01 34 01
(Руководство оператора)      
                   
       (пример — .pdf)
514 137 b Загрузить
A.B.00001-01 34 01
(Руководство оператора)      
                   
       (шаблон — .dot)
17 902 b Загрузить

На верх

==================================

Рекомендуемая структура программного документа (по ГОСТ 19.505-79. ЕСПД)

  • Лист утверждения
  • Титульный лист
  • Аннотация
  • Содержание
  • Основная часть
    • Назначение программы
      • Функциональное назначение программы
      • Эксплуатационное назначение программы
      • Состав функций
        • Функции (такой-то)
      • Функции (этакой)

    • Условия выполнения программы
      • Минимальный состав аппаратных средств
      • Минимальный состав программных средств
      • Требования к персоналу (пользователю)
    • Выполнение программы
      • Загрузка и запуск программы
      • Выполнение программы
        • Выполнение функции (такой-то)
        • Выполнение функции (этакой)
      • Завершение работы программы
    • Сообщения  оператору
      • Сообщение (такое-то)
      • Сообщение (этакое)
  • Приложения (необязательны)
  • Регистрация изменений

На верх

==================================

<Предыдущий>
<Содержание>

Министерство
образования

Российской
Федерации

Саратовский
государственный технический университет

Утверждаю

Зав. кафедрой ПВС

______В.Б. Байбурин

__. __.
2007

ТЕОРИЯ ЯЗЫКОВ
ПРОГРАММИРОВАНИЯ

И МЕТОДЫ
ТРАНСЛЯЦИИ

ТРАНСЛЯТОР

Руководство
оператора

ЛИСТ
УТВЕРЖДЕНИЯ

КФБН. 00000-01
34
01-1
ЛУ

СОГЛАСОВАНО
Разработчик:

Руководитель работы
Студент
ПВС-41

________ Сайкин А.И.
________ Давыдов
Ю.А.

__.__.2007
__.__.2007

Нормоконтролер

_______ Сайкин
А.И.

__.__.2007

2007

Министерство
образования

Российской
Федерации

Саратовский
государственный университет

Утверждено

КФБН.
00000-01 34 01-1-ЛУ

ТЕОРИЯ ЯЗЫКОВ
ПРОГРАММИРОВАНИЯ

И МЕТОДЫ
ТРАНСЛЯЦИИ

ТРАНСЛЯТОР

Руководство
оператора

КФБН. 00000-01 34 01-1

Листов 3

2007

Соседние файлы в папке Курсовик

  • #
  • #
  • #
  • #
  • #
  • #
  • #
  • #

Тарифы

Подписка на тарифы временно недоступна.

Гост Ассистент

Статус документа

Функция доступна в рамках платных тарифов. Приобретите подписку на 1 месяц и пользуйтесь сервисом без ограничений.
Подробнее.

Скачать документ

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

Функция доступна в рамках платных тарифов. Приобретите подписку на 1 месяц и пользуйтесь сервисом без ограничений.
Подробнее.

Добавление в избранное

Функция доступна в рамках платных тарифов. Приобретите подписку на 1 месяц и пользуйтесь сервисом без ограничений.
Подробнее.

Текст документа недоступен. Вы можете скачать документ в формате rtf.


Вверх

Журавлев Денис

Когда и у кого возникает необходимость создания руководства пользователя по ГОСТ

Многие IT-компании, которые занимаются разработкой и сопровождением программного обеспечения и автоматизированных комплексов, сталкиваются с задачей создания пользовательской документации или руководств для своих продуктов в соответствии с требованиями ГОСТ.

Как правило, необходимость в наличии пользовательского руководства, составленного по ГОСТ, возникает при сотрудничестве с государственными организациями, крупными производствами и компаниями, при заказной разработке программного обеспечения по тендерам и госзаказам или при необходимости добавить программный продукт в «Единый реестр российских программ для электронных вычислительных машин и баз данных (реестр отечественного ПО)».

Какие ГОСТ используются при написании руководства пользователя приложения

Существует две серии (набора) стандартов, которые регламентируют набор создаваемых документов и правила их оформления при разработке автоматизированных систем, комплексов и программного обеспечения:

  • ГОСТ 34 — Автоматизированные системы
  • ГОСТ 19 — Единая система программной документации (ЕСПД)

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

ГОСТ 34 главным образом определяет комплектность, виды, структуру и содержание создаваемых документов.

ГОСТ 19 в большей степени определяет правила оформления документов.

Поэтому, на практике часто используются сразу оба этих ГОСТа.

Руководство пользователя — основной документ для конечного пользователя

Если говорить именно о документации для конечного пользователя системы, то из перечня описываемых в ГОСТ 34 документов нас интересует «Руководство пользователя». В ГОСТ 19 аналогичный по смыслу документ называется «Руководство оператора», но для программного обеспечения чаще используется именно первый вариант.

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

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

Для начинающего технического писателя или простого специалиста, которому неожиданно поручили написать руководство пользователя по ГОСТ, эта задача является серьезной проблемой.

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

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

У опытного технического писателя документирование по ГОСТ, возможно, не вызовет серьезных затруднений. Однако, даже у него подготовка шаблонов новых документов, приведение к требованиями стандартов существующей документации или проверка финального документа на соответствие этим требованиям может занять существенное время.

Dr.Explain упрощает создание руководства пользователя по ГОСТ

Начиная с версии 5.5.1100 программа для создания пользовательской документации Dr.Explain предлагает функцию автоматизированной поддержки ГОСТ в проектах. Эта функция призвана значительно облегчить жизнь пользователям, перед которыми стоит задача создания руководства пользователя в соответствии с требованиями государственных стандартов.

В частности программа Dr.Explain контролирует и автоматизирует поддержку следующих требований стандартов:

  • Наличие обязательных разделов документа “Руководство пользователя” [ГОСТ 34 РД 50-34.698-90]. Все разделы снабжаются пояснениями по их содержанию.
  • Оформление титульных листов, аннотации и содержания [ГОСТ 19.105-78, 19.104-78].
  • Параметры печатных страниц документа и расположение основных элементов на них [ГОСТ 19.106-78].
  • Структуру и оформление колонтитулов [ГОСТ 19.106-78].
  • Оформление текстовой части документа: стили шрифтов, абзацные отступы, межстрочные интервалы [ГОСТ 19.106-78].
  • Формирование и оформление заголовков, разделов, перечислений (списков) [ГОСТ 19.106-78].

Управление функцией поддержки ГОСТ для проекта доступно в Настройках проекта в разделе Общие.

При включенном режиме поддержки ГОСТ для проекта соответствующие пользовательские настройки для печатаемых форматов RTF\DOC и PDF автоматически перекрываются программой, что гарантирует полное соответствие параметров выходных документов требованиям стандартов.

Для выходных форматов HTML и CHM будут использоваться пользовательские настройки вне зависимости от активности режима поддержки ГОСТ. Это снимает ограничение на свободную стилизацию этих форматов и позволяет, например, оформить онлайн-справку полностью в корпоративном или тематическом стиле.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Важно: Функция поддержки ГОСТ доступна в Dr.Explain только в русскоязычной версии интерфейса. Язык интерфейса программы выбирается в меню Настройки\Выбор языка программы (Options\Application language).

Создание нового руководства пользователя по ГОСТ

Для создания нового руководства пользователя по требованиям ГОСТ 34 в программе Dr.Explain можно использовать команды меню Файл \ Создать локальный проект — Руководство пользователя по ГОСТ 34 или Файл \ Создать общий проект на tiwri.com — Руководство пользователя по ГОСТ 34

или аналогичные кнопки на стартовом экране приложения.

Программа создаст новый проект, в котором уже присутствуют шаблон титульного листа, аннотация, оглавление и обязательные разделы, оформленные по ГОСТ.

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

Настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

Приведение существующей пользовательской документации в соответствие с требованиями ГОСТ

Также программа Dr.Explain позволяет привести существующую пользовательскую документацию в соответствии с требованиями ГОСТ.

Важно: Перед включением режима поддержки ГОСТ для уже существующих в формате Dr.Explain проектов необходимо сделать резервную копию gui-файла проекта.

Если исходная документация еще не ведется в Dr.Explain, а хранится в других форматах, первым шагом необходимо выполнить импорт существующих документов в программу. Dr.Explain поддерживает импорт документов из ряда популярных форматов. Команды импорта доступны как на стартовом окне программы, так и в меню Файл.

Затем необходимо включить режим поддержки ГОСТ в свойствах проекта описанным ранее способом.
Программа проверит структуру документа на наличие обязательных разделов и, если они отсутствуют, создаст их. Остальные существующие разделы, наличие которых не регламентировано ГОСТами, будут перенесены в скрытый от экспорта раздел “Старое дерево разделов”.

Пользователь должен будет перенести содержимое этих разделов или разделы целиком методом drag-n-drop в основное дерево проекта и отредактировать их по необходимости.

Как и в первом случае настройки оформления для печатных форматов RTF/DOC и PDF будут выставлены в соответствии с требованиям ГОСТ 19.

 Создайте документацию, соответсвующую ГОСТ 19 и ГОСТ 34 в Dr.Explain бесплатно

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

  • Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

Понравилась статья? Поделить с друзьями:
  • Заферан коралловый клуб инструкция по применению
  • Ансамбль ритмы планеты под руководством санкина
  • Тактика фельдшера фельдшерско акушерского пункта практическое руководство двойников скачать
  • Инструкция к швейной электрической машинке чайка 142 м
  • Коделак форте таблетки инструкция по применению