Документирование программных изделий ЕСПД


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


Аннотация и содержание обязательны.

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

  • Общие сведения - обозначение и наименование программы; программное обеспечение, необходимое для функционирования программы; языки программирования, на которых написана программа.
  • Функциональное назначение - классы решаемых задач и/или назначение программы и сведения о функциональных ограничениях на ее применение.
  • Описание логической структуры - алгоритм программы; используемые методы; структура программы с описанием функций составных частей и связи между ними; связи программы с другими программами. Описание логической структуры программы выполняют с учетом текста программы на исходном языке.
  • Используемые технические средства - типы ЭВМ и устройств, которые используются при работе программы.
  • Вызов и загрузка - способы вызова программы с соответствующего носителя данных; входные точки в программу. Допускается здесь указывать адреса загрузки, сведения об использовании оперативной памяти, объем программы.
  • Входные данные - характер, организация и предварительная подготовка входных данных, формат, описание и способ кодирования входных данных.
  • Выходные данные - характер и организация выходных данных; формат, описание и способ кодирования выходных данных.

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

Перечень документов


Начало  Назад  Вперед