ВСПОМОГАТЕЛЬНЫЕ ДОКУМЕНТЫ ГОСТ 19¶

Выдержки из стандартов, связанных с оформлением и содержанием¶

«Описания программы», «Руководства оператора», «Руководства системного программиста» и «Формуляра»¶

1. ГОСТ 19.101-77 — Виды программ и программных документов¶

Определяет перечень документов, которые входят в состав документации на программное средство. Именно этот стандарт устанавливает, что такие документы, как «Описание программы», «Руководство оператора», «Руководство системного программиста», «Формуляр», являются обязательными или рекомендуемыми видами документов.

Ключевые выдержки (содержание):

```markdown

ВИДЫ ПРОГРАММНЫХ ДОКУМЕНТОВ¶

ГРУППЫ ДОКУМЕНТОВ:¶

1. Документы, определяющие состав программы:¶

Спецификация (ГОСТ 19.202-78)
Ведомость держателей подлинников
Ведомость эксплуатационных документов (ГОСТ 19.507-79)

2. Документы, описывающие программу:¶

Описание программы (ГОСТ 19.402-78)
Пояснительная записка (ГОСТ 19.404-79)

3. Документы, определяющие порядок использования:¶

Руководство оператора (ГОСТ 19.505-79)
Руководство системного программиста (ГОСТ 19.503-79)
Руководство программиста (ГОСТ 19.504-79)

4. Документы, удостоверяющие состояние:¶

Формуляр (ГОСТ 19.501-78)
Патентный формуляр

5. Прочие документы:¶

Текст программы (ГОСТ 19.401-78)
Программа и методика испытаний (ГОСТ 19.301-79)

СТАДИИ РАЗРАБОТКИ ПРОГРАММ И ПРОГРАММНОЙ ДОКУМЕНТАЦИИ¶

1. ТЕХНИЧЕСКОЕ ЗАДАНИЕ¶

Обоснование разработки
Требования к программе
Требования к документации
Порядок приемки

2. ЭСКИЗНЫЙ ПРОЕКТ¶

Разработка структуры программы
Уточнение методов решения
Разработка документации в объеме:
Пояснительная записка (эскизная)
Описание программы (укрупненное)

3. ТЕХНИЧЕСКИЙ ПРОЕКТ¶

Уточнение структуры
Разработка алгоритмов
Разработка документации:
Описание программы (полное)
Руководство оператора (черновик)
Руководство системного программиста (черновик)

4. РАБОЧИЙ ПРОЕКТ¶

Кодирование и отладка
Испытания
Корректировка документации
Окончательное оформление:
Текст программы
Описание программы
Руководства
Формуляр

5. ВНЕДРЕНИЕ¶

Передача в эксплуатацию
Опытная эксплуатация
Сопровождение

ПРАВИЛА ОБОЗНАЧЕНИЯ ПРОГРАММ И ДОКУМЕНТОВ¶

СТРУКТУРА ОБОЗНАЧЕНИЯ:¶

XXXX.XXXXXX-XX

Где:¶

XXXX — код организации-разработчика
XXXXXX — порядковый номер программы (классификационный код)
XX — код вида документа:
12 — Текст программы
13 — Описание программы
20 — Руководство оператора
21 — Руководство системного программиста
30 — Формуляр
32 — Руководство программиста
51 — Программа и методика испытаний

ПРИМЕРЫ:¶

АВСБ.123456-13 — Описание программы
АВСБ.123456-20 — Руководство оператора
АВСБ.123456-30 — Формуляр

ТЕРМИНЫ И ОПРЕДЕЛЕНИЯ (выдержка)¶

ОСНОВНЫЕ ПОНЯТИЯ:¶

Программа (Program)¶

Данные, предназначенные для управления конкретными компонентами системы обработки информации в целях реализации определенного алгоритма.

Программное изделие (Software Product)¶

Программа, предназначенная для поставки, передачи, продажи пользователю.

Документация на программу (Program Documentation)¶

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

Оператор (Operator)¶

Лицо, непосредственно взаимодействующее с программой в процессе ее выполнения.

Системный программист (System Programmer)¶

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

Входные данные (Input Data)¶

Данные, поступающие в программу извне.

Выходные данные (Output Data)¶

Данные, передаваемые программой во внешнюю среду.

Формуляр (Formulary)¶

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

Ошибка (Error)¶

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

Сбой (Fault)¶

Самоустраняющийся отказ или однократный отказ, устраняемый незначительным вмешательством.

ОБЩИЕ ТРЕБОВАНИЯ К ОФОРМЛЕНИЮ ПРОГРАММНЫХ ДОКУМЕНТОВ¶

1. СОСТАВ ДОКУМЕНТА¶

Титульный лист
Информационная часть (аннотация, содержание)
Основная часть
Часть регистрации изменений

2. ТРЕБОВАНИЯ К ТИТУЛЬНОМУ ЛИСТУ¶

Наименование организации-разработчика
Гриф утверждения
Вид документа (например: ОПИСАНИЕ ПРОГРАММЫ)
Наименование программы
Обозначение документа
Подписи разработчиков и нормоконтролера

3. ТРЕБОВАНИЯ К ИНФОРМАЦИОННОЙ ЧАСТИ¶

3.1. Аннотация¶

// Должна содержать: - Сведения о назначении документа - Краткую характеристику программы - Сведения об объеме (если применимо)

3.2. Содержание¶

// Должно включать: - Перечень всех разделов и подразделов - Номера страниц

4. ТРЕБОВАНИЯ К ОСНОВНОЙ ЧАСТИ¶

Разделы нумеруются арабскими цифрами
Подразделы — составные номера (например: 2.1, 2.2)
Допускается вводить дополнительные разделы
Допускается объединять или исключать разделы (по согласованию с заказчиком)

5. ТРЕБОВАНИЯ К ЛИСТУ РЕГИСТРАЦИИ ИЗМЕНЕНИЙ¶

// Таблица с колонками: | Изм. | Номера листов | Всего листов | № документа | Входящий № | Подпись | Дата | |------|----------------|--------------|-------------|------------|---------|------| | | измененных/замененных/новых/аннулированных | | | | | |

6. ТРЕБОВАНИЯ К НУМЕРАЦИИ СТРАНИЦ¶

Титульный лист не нумеруется
Нумерация начинается с раздела «Содержание»
Номера проставляются в верхнем или нижнем колонтитуле