Документ описание программы пример

разработка техдокументации

Описание программы по ГОСТ 19.402-78

Описание программы по ГОСТ 19.402-78

Создан 29.01.2010 11:07:14

Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78. Составление информационной части (аннотации и содержания) является обязательным [из п. 2 ГОСТ 19.402-78]

Описание программы должно содержать следующие разделы:

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы [из п. 3 ГОСТ 19.402-78]

Общие сведения

В разделе «Общие сведения» должны быть указаны:

[из п. 4 ГОСТ 19.402-78]

Функциональное назначение

В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение [из п. 5 ГОСТ 19.402-78]

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

В разделе «Описание логической структуры» должны быть указаны:

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

Описание логической структуры программы выполняют с учетом текста программы на исходном языке [из п. 6 ГОСТ 19.402-78]

Используемые технические средства

В разделе «Используемые технические средства» должны быть указаны типы электронно-вычислительных машин и устройств, которые используются при работе программы [из п. 7 ГОСТ 19.402-78]

Вызов и загрузка

В разделе «Вызов и загрузка» должны быть указаны:

• способ вызова программы с соответствующего носителя данных;
• входные точки в программу.

Допускается указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы [из п. 8 ГОСТ 19.402-78]

Входные данные

В разделе «Входные данные» должны быть указаны:

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

[из п. 9 ГОСТ 19.402-78]

Выходные данные

В разделе «Выходные данные» должны быть указаны:

• характер и организация выходных данных;
• формат, описание и способ кодирования выходных данных.

[из п. 10 ГОСТ 19.402-78]

Допускается содержание разделов иллюстрировать пояснительными примерами, таблицами, схемами, графиками [из п. 11 ГОСТ 19.402-78]

В приложение к описанию программы допускается включать различные материалы, которые нецелесообразно включать в разделы описания [из п. 12 ГОСТ 19.402-78]

Структура и содержание документа

Требования к структуре описания программы по ГОСТ 19 устанавливаются ГОСТ 19.402. В общем случае документ должен состоять из следующих разделов:

1. Общие сведения
1.1. Обозначение и наименование программы
1.2. Программное обеспечение, необходимое для функционирования программы
1.3. Языки программирования, на которых написана программа
2. Функциональное назначение
3. Описание логической структуры
3.1. Алгоритм программы
3.2. Используемые методы
3.3. Структура программы с описанием функций составных частей и связи между ними
3.4. Связи программы с другими программами
4. Используемые технические средства
5. Вызов и загрузка
5.1. Способ вызова программы с соответствующего носителя данных
5.2. Входные точки в программу
6. Входные данные
6.1. Характер, организация и предварительная подготовка входных данных
6.2. Формат, описание и способ кодирования входных данных
7. Выходные данные
7.1. Характер и организация выходных данных
7.2. Формат, описание и способ кодирования выходных данных

Примечание

Оформление документа

Документ оформляется в соответствии с правилами предусмотренными ГОСТ 19.105, ГОСТ 19.106 и другими стандартами Единой системы программной документации (ЕСПД).

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

Все шаблоны предоставляются бесплатно!

Если не нашли шаблона, то пишите здесь

Если у Вас есть шаблоны документов, которых еще нет в этом каталоге, то просим прислать их на нашу почту. Помогите своим коллегам!

Благодарность за помощь в пополнении коллекции выражаем: Максиму Казначееву

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