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

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

Требования к структуре описания программы по ГОСТ 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.402-78

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

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

Читайте также:  Asi loader как пользоваться

Структуру и оформление документа устанавливают в соответствии с ГОСТ 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]

Читайте также:  1С количество при изменении

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

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

Г О С У Д А Р С Т В Е Н Н Ы Й С Т А Н Д А Р Т С О Ю З А С С Р

Единая система программной документации

(СТ СЭВ 2092-80)

ОПИСАНИЕ ПРОГРАММЫ

United system for program documentation.
Program description

Постановлением Государственного комитета СССР по стандартам от 18 декабря 1978 г. № 3350 срок введения установлен

1. Настоящий стандарт устанавливает состав и требования к содержанию программного документа «Описание программы», определённого ГОСТ 19.101-77.

Стандарт полностью соответствует СТ СЭВ 2092-80.

2. Структуру и оформление документа устанавливают в соответствии с ГОСТ 19.105-78.

Составление информационной части (аннотации и содержания) является обязательным.

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

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

В зависимости от особенностей программы допускается вводить дополнительные разделы или объединять отдельные разделы.

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

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

5. В разделе «Функциональное назначение» должны быть указаны классы решаемых задач и (или) назначение программы и сведения о функциональных ограничениях на применение.

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

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

Описание логической структуры программы выполняют с учетом текста программы на исходном языке.

3-6.(Измененная редакция, Изм. № 1).

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

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

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

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

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

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

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

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

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

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

7-12.(Введены дополнительно, Изм. № 1).

* Переиздание (Ноябрь 1987 г.) с Изменением № 1, утвержденным в сентябре 1981 г (ИУС 11-81)