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

Конспект урока русского языка в 6 классе на тему «Фразеологизмы»
Конспект
Цели урока: углубить и расширить знания о фразеологизмах русского языка; развивать речевые умения и навыки, обогащать речь учащихся; прививать любовь ...полностью>>

Урок «открытия» нового знания Тема урока «Ломаная линия. Многоугольник»
Урок
Учитель: Я предлагаю поработать вам в группах. Назовите правила работы. Ученики: Каждый имеет право высказать своё мнение, остальные должны выслушать....полностью>>

Конспект открытого урока по теме «Буквы е, и в окончаниях глаголов»
Конспект
По буквам нетрудно определить спряжение, а как быть, если буква в окончании пропущена или её надо написать на слух? (Дети проговаривают алгоритм, зате...полностью>>

Методические указания по выполнению дипломного проекта
Методические указания
Методические указания составлены в соответствии с требованием ГОСО специальности 5В071400- «Авиационная техника и технологии»5В074300 «Летная эксплуат...полностью>>



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

По мнению автора, рекомендации IEEE Std 1063-2001, разработанного при участии сотни забугорных спецов, весьма и весьма поверхностны. Не сможет разработчик, работая по IEEE Std 1063-2001, охватить максимум «характеристик», свойственных программе. В IEEE Std 1063-2001 многие из них попросту не прописаны. Отсутствуют «широта охвата» и «глубина проработки», свойственные отечественным документам.

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

ГОСТ 19 (ЕСПД)

В отличие от суперсовременного буржуйского IEEE Std 1063-2001, древние, многими ругаемые, отечественные ГОСТы 19 серии (Единая Система Программной Документации - ЕСПД) содержат не пространные рассуждения о том, что и как должно разъяснять, иллюстрировать и описывать руководство пользователя, а конкретные требования к структуре и содержанию пользовательских документов.

Перечень ГОСТ 19 «описательного» характера, на основе которых можно, не мудрствуя лукаво, сформировать четкую структуру разделов каждого из «описательных» документов, приведен в разделе Источники. Основной прием - детализация, подробно описан в статье «Как писать техническое задание!?».

Далее - сформированные «детализацией» структуры разделов документов согласно ГОСТ из перечня.

ГОСТ 19.402-78 - структура разделов

ГОСТ 19.502-78 - структура разделов

ГОСТ 19.503-79 - структура разделов

ГОСТ 19.504-79 - структура разделов

ГОСТ 19.505-79 - структура разделов

Выводы по ГОСТ 19

Ни ГОСТ 19.505-79, ни ГОСТ 19.504-79, ни ГОСТ 19.503-79 (эксплуатационные), взятые по одельности, не могут похвастаться достаточной полнотой структуры.

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

А почему не попытаться объединить все «описательные» документы? Объединить идентичные и схожие разделы документов, выделить специфические разделы? Быть может, удастся избавиться от неполноты ГОСТ 19.505-79, ГОСТ 19.504-79 и ГОСТ 19.503-79 и получить обобщенную структуру «описательного» документа - руководства пользователя?

ГОСТ 19 допускает «вводить дополнительные разделы или объединять отдельные разделы», а также «вводить новые». Согласно п. 2.6 ГОСТ 19.101-77 допускается объединять отдельные виды эксплуатационных документов. Необходимость объединения этих документов указывается в техническом задании. Объединенному документу присваивают наименование и обозначение одного из объединяемых документов.

Сказано - сделано. Только мы нарушим ГОСТ и создадим объединенный документ под названием «Руководство пользователя».

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

Путем слияния структур «описательных» документов ГОСТ 19 в единую структуру, удаления «лишних» одноименных разделов, слияния схожих разделов сформирована общая структура руководства пользователя.

В табличке сведены и * отмечены разделы, присутствующие в каждом отдельном документе.

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

ГОСТ 19.402-78

ГОСТ 19.502-78

ГОСТ 19.503-79

ГОСТ 19.504-79

ГОСТ 19.505-79

Аннотация

*

*

*

*

*

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

*

*

*

*

*

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

*

*

*

*

*

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

*

 

*

 

 

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

*

 

 

*

 

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

*

 

 

 

 

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

*

*

*

*

*

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

 

 

 

 

*

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

 

*

 

 

 

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

*

 

 

 

 

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

 

*

 

 

 

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

 

*

 

 

 

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

 

 

*

*

 

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

 

*

 

*

 

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

 

 

 

*

 

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

 

 

 

*

 

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

 

 

 

*

 

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

 

*

 

 

 

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

*

 

 

 

 

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

 

*

 

*

*

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

 

*

*

 

*

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

 

 

*

 

 

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

*

*

 

 

 

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

*

 

 

 

 

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

 

 

 

*

 

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

 

 

 

 

*

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

 

 

 

*

 

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

*

 

 

 

 

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

 

 

 

*

 

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

 

*

 

 

 

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

 

*

 

 

 

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

*

 

 

 

 

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

*

 

 

 

 

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

*

 

 

 

 

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

*

 

*

 

 

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

 

 

*

 

 

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

*

 

 

 

 

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

*

 

*

 

 

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

*

 

*

 

 

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

 

*

 

*

 

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

 

*

 

 

 

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

*

*

 

 

 

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

*

 

 

*

 

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

*

*

 

 

 

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

*

 

 

*

 

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

*

 

 

 

 

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

 

 

 

*

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

 

 

*

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

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

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

*

 

 

*

*

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

 

 

 

 

*

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

*

 

 

 

 

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

 

 

 

*

 

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

 

 

 

 

*

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

 

 

 

 

*

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

 

 

 

 

*

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

 

 

 

 

*

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

 

 

 

 

*

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

 

 

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

 

 

*

*

*

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

 

 

*

*

*

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

 

 

*

*

*

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

 

 

*

*

*

Выводы по обобщенной структуре руководства пользователя по ГОСТ 19