Создание руководств пользователя ПО в AuthorIT

Создан 25.12.2006 12:03:17

Создание руководств пользователя ПО не представляет особых проблем - в папке Notepad библиотеки sample.adl имеется образец пользовательского руководства - книга - Пиктограмма книги Using Notepad, см. рисунок ниже.

- Образец руководства Using Notepad

Структура книги отдаленно напоминает структуру пользовательского руководства на основе IEEE Std 1063-2001 IEEE Standard for Software User Documentation, использовать ли указанный образец в качестве основы пользовательского руководства - каждый решает сам. Шаблон AuthorIT.dot, поставляемый с AuthorIT по умолчанию, также изначально настроен на публикацию пользовательских руководств с зарубежными стилями оформления, не укладывающимися в рамки отечественных ГОСТов, см. Первая публикация - первое разочарование.

Для создания пользовательских руководств на ПО согласно требованиям отечественных ГОСТ 19.ххх потребуется как совершенно иная структура разделов самого руководства, так и иная настройка шаблонов оформления документов. Приемы создания структуры разделов книг рассмотрены в подразделе Импорт в библиотеку AuthorIT полных текстов ГОСТ 34 и РД 50-34.698-90, но вместо ГОСТ 34.ххх в библиотеку следует импортировать полные тексты ГОСТ 19.ххх, настройка шаблонов рассмотрена в подразделе Единообразное оформление документов в AuthorIT. Следует, опять же, сделать поправку на требования ГОСТ 19.ххх. Примерная структура разделов руководства пользователя, не противоречащая требованиям ГОСТ 19.ххх, приведена в таблице ниже1.

- Структура руководства пользователя ПО по ГОСТ 19

ГОСТ 19.ххх - обобщенная структура разделов руководства

ГОСТ 19.402-78

ГОСТ 19.502-78

ГОСТ 19.503-79

ГОСТ 19.504-79

ГОСТ 19.505-79

Аннотация

*

*

*

*

*

•Назначение документа

*

*

*

*

*

•Краткое изложение основной части документа

*

*

*

*

*

Общие сведения о программе

*

*

•Обозначение и наименование программы

*

*

Языки программирования, на которых написана программа

*

•Сведения о назначении программы

*

*

*

*

*

••Информация, достаточная для понимания функций программы и ее эксплуатации

*

•••Возможности программы

*

•••Классы решаемых задач

*

••••Описание задач

*

••••Методы решения задач

*

•••Функции, выполняемые программой

*

*

••Описание основных характеристик и особенностей программы

*

*

•••Временные характеристики

*

•••Режим работы

*

•••Средства контроля правильности выполнения и самовосстанавливаемости программы

*

••Ограничения области применения программы

*

•••Сведения о функциональных ограничениях на применение

*

Условия применения программы

*

*

*

•Условия, необходимые для выполнения программы

*

*

*

••Сведения о технических и программных средствах, обеспечивающих выполнение программы

*

•••Требования к техническим средствам

*

*

••••Типы ЭВМ, устройства, используемые при работе программы

*

••••Объем оперативной памяти

*

••••Минимальный и (или) максимальный состав аппаратурных и программных средств

*

••••Требования к составу и параметрам периферийных устройств

*

•••Программное обеспечение, необходимое для функционирование программы

*

••••Требования к программному обеспечению

*

••••Требования к другим программам

*

••••Требования и условия организационного, технического и технологического характера

*

Описание логической структуры

*

Алгоритм программы

*

•Используемые методы

*

•Сведения о структуре программы

*

*

•Сведения о составных частях программы

*

•Описание функций составных частей

*

•Сведения о связях между составными частями программы

*

*

•Сведения о связях с другими программами

*

*

Сведения о входных и выходных данных

*

*

•Общие характеристики входной и выходной информации

*

•Сведения о входных данных

*

*

••Характер, организация и предварительная подготовка входных данных

*

*

•Сведения о выходных данных

*

*

••Характер и организация выходных данных

*

*

••Формат, описание и способ кодирования выходных данных

*

•Описание кодирования информации

*

Настройка программы

*

•Описание действий по настройке программы

*

••Настройка на состав технических средств

*

••Выбор функций

*

••Поясняющие примеры

*

Проверка программы

*

•Описание способов проверки работоспособности программы

*

••Контрольные примеры

*

••Методы прогона

*

••Результаты

*

Выполнение программы

*

•Загрузка программы
•Способ вызова программы с соответствующего носителя данных
•Описание процедур вызова программы

*

*

*

•Запуск программы

*

•Входные точки в программу*

*

•Способы передачи управления и параметров данных

*

•Выполнение программы

*

••Описание выполняемой функции 1

*

••Формат и возможные варианты команд для выполнения функции 1

*

••Ответы программы на команды выполнения функции 1

*

•Завершение выполнения программы

*

Дополнительные возможности

*

•Описание дополнительных функциональных возможностей программы

*

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

*

Сообщения программы

*

*

*

•Тексты сообщений, выдаваемых в ходе (настройки, проверки, выполнения) программы

*

*

*

••Описание содержания

*

*

*

••Описание действий, которые необходимо предпринять по этим сообщениям

*

*

*

Книга, содержащая структуру руководства пользователя, приведенную в таблице, имеется на прилагаемом к книге компакт-диске2.

На рисунке выше, между пунктами 1 и 2 списка, выполненных стилем List Number, вставлен рисунок. Подобная вставка возможна лишь с применением двух знаков мягкого переноса, они отображены в топике в виде «.

Примечания от 19.08.2014:

  1. Исходная таблица заменена на более «продвинутую».
  2. Нет компакт-диска.