Похожие публикации

Локальные и глобальные компьютерные сети. Определение локальной сети
Документ
Способов и средств обмена информацией за последнее время предложено множество: от простейшего переноса файлов с помощью дискеты до всемирной компьютер...полностью>>

Образец декларации о соответствии
Документ
сведения о регистрации организации или индивидуального предпринимателя (наименование регистрирующего органа, дата регистрации, регистрационный номер),...полностью>>

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

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



Задачи: определиться со структурой разделов руководства пользователя; определиться с заполнением разделов руководства пользователя содержимым

Обобщенная структура руководства пользователя по ГОСТ 19 явно не страдает, как IEEE Std 1063-2001, отсутствием широты охвата. Избыток, как известно, рождает качество. Перечислено все, чем может характеризоваться программа. Отдельные подразделы могут показаться даже излишними, к примеру, подраздел «Языки программирования, на которых написана программа».

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

В то же время, при всей широте охвата, в явном виде отсутствуют:

  • Software installation and de-installation, if performed by the user;

  • Orientation to use of the features of the graphical user interface;

  • Access, or log-on and sign-off the software;

  • Navigation through the software to access and to exit from functions и многое другое.

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

Показать связи разделов обобщенного руководства пользователя с разделами ГОСТ 19.201-78 ЕСПД. Техническое задание, требования к содержанию и оформлению автор поленился, поскольку указанные связи очевидны.

Выводы по источникам

Итак, если первая задача в целом решена, вторая задача осталась нерешенной.

Автор манифеста более склонен к рекомендациям по подбору слов и построению предложений, IEEE Std 1063-2001, в лучшем случае, приводит требования к структуре руководства пользователя, но не дает особой конкретики, в ГОСТ 19 не прописаны процедуры заполнения содержимым разделов руководства. Может, организовать эдакую смесь французского с нижегородским? Использовать все три источника в качестве трех составных частей?

Смесь французского с нижегородским

Почему бы нет? Взять лучшее, что можно «высосать» из ГОСТ 19, - обобщенную структуру руководства пользователя, добавить к ней немногочисленные толковые рекомендации из IEEE Std 1063-2001 и разбавить неисчерпаемой стилистической культурой и ресурсами языка из манифеста Кагарлицкого? Придать смеси стройный строгий вид, сформировать очередной учебно-тренировочный документ с подробными комментариями? А что делать, если ни один из перечисленных выше трех источников и трех составных частей в отдельности не способны дать ответы на все поставленные вопросы?

Об этом - в очередной статье.

Таблица соответствия ГОСТ 19 и IEEE Std 1063-2001

ГОСТ 19

IEEE Std 1063-2001

Аннотация

Introduction

 

The introduction shall describe the intended audience, scope, and purpose for the document and include a brief overview of the software purpose, functions, and operating environment

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

purpose for the document (Introduction)

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

scope (Introduction)

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

 

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

 

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

 

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

brief overview of the software purpose (Introduction)

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

 

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

 

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

 

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

 

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

Documentation shall relate each documented function to the overall process or tasks

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

brief overview of the software ... functions (Introduction)

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

 

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

 

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

 

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

 

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

 

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

 

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

If different versions of the software are available for different operating environments, the title page should specify the applicable operating environment(s), including version(s) of hardware, communications, and operating system(s) (4.3. Content of identification data)

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

 

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

Documentation for the hardware and software environment (4.11 Information on related information sources)

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

 

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

 

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

 

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

 

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

 

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

brief overview of the ... operating environment (Introduction)

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

 

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

 

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

 

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

 

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

algorithms (4.5 Concept of operations)

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

using such methods as a visual or verbal overview of the process or workflow (4.5 Concept of operations)

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

 

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

Identification of technical or administrative activities that must be done before starting the task (4.7 Information for procedures and tutorials)

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

 

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

 

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

 

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

 

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

 

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

 

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

Examples should illustrate the use of commands (4.8 Information on software commands)

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

 

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

 

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

 

- Загрузка программы

- Способ вызова программы с соответствующего носителя данных

- Описание процедур вызова программы

Software installation and de-installation, if performed by the user (4.6 Information for general use of the software)

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

 

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

Access, or log-on and sign-off the software (4.6 Information for general use of the software)

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

 

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

 

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

A brief overview of the purpose of the procedure and definitions or explanations of necessary concepts not elsewhere included (4.7 Information for procedures and tutorials)

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

Navigation through the software to access ... functions (4.6 Information for general use of the software)

Instructional steps shall be presented in the order of performance (4.7 Information for procedures and tutorials)

Documentation shall explain how to interrupt and undo operation during execution of a command and how to restart it, if possible.

Documentation shall explain the formats and procedures for user-entered software commands, including required parameters, optional parameters, default options, order of commands, and syntax (4.8 Information on software commands)

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

Documentation shall describe how to recognize that the command has successfully executed or abnormally terminated (4.8 Information on software commands)

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

Navigation through the software ... to exit from functions

Methods of canceling, interrupting, and restarting operations (4.6 Information for general use of the software)

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

 

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

 

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

 

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

Relevant warnings, cautions, and notes that apply to the entire procedure (4.7 Information for procedures and tutorials)

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

 

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

 

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