Описание программы#

Note

“Описание программы” - это документ, который подробно объясняет, как работает программа, включая ее функциональное назначение, структуру, способ вызова, обработку данных и формат вывода, а также содержит сведения о технических средствах и изменениях. Этот документ помогает понять, как была разработана программа, как использовать и взаимодействовать с ней.

Справочная информация#

  • Серия: ГОСТ 19

  • ГОСТ: ГОСТ 19.402-78 Описание программы. Требования к содержанию и оформлению

  • Код вида документа: 13

  • Пример децимального номера: ХХХ.ХХХХХХХХ.ХХХХХ-13 01

  • Пользователи документа: Разработчики

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

  • Шаблон документа: “Описание программы” по ГОСТ 19

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

  • Лист утверждения

  • Титульный лист

  • Аннотация

  • Содержание

  • Основная часть
    • Общие сведения

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

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

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

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

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

      • Назначение программы

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

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

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

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

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

      • Связи программы с другими программами

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

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

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

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

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

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

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

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

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

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

  • Регистрация изменений