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


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


Титульный лист заполняют по форме и правилам, установленным для ЛУ, но при этом:

  • Поле 1 - заполняется по требованию заказчика;
  • Поле 2 - не заполняется.
  • Поля 3,4 - как в ЛУ.
  • Поле 5 - указывают объем документа;
  • поле 6 - не заполняют;
  • Поля 7-10 - как в ЛУ.

На титульном листе в левом верхнем углу должна быть надпись: Утвержден -------------- обозначение ЛУ

Пример заполнения титульного листа приведен ниже:

Информационная часть должна состоять из аннотации и содержания. Необходимость включения информационной части в различные виды программных документов установлена соответствующими стандартами ЕСПД на эти документы.

В аннотации приводятся сведения о назначении документа и краткое содержание его основной части.

Содержание включает в себя перечень записей о структурных элементах основной части документа, в каждую из которых входят:

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

Состав и структура основной части программного документа устанавливаются стандартами ЕСПД на соответствующие документы.

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

Материалы программного документа располагают в следующей последовательности:

  • титульная часть
    • лист утверждения (не входит в общее количество листов документа);
    • титульный лист (первый лист документа);
  • информационная часть;
    • аннотация;
    • лист содержания;
  • основная часть;
    • текст документа (с рисунками, таблицами и т..п.);
    • приложения; 1)
    • перечень терминов; 1) 2)
    • перечень сокращений; 1) 2)
    • перечень рисунков; 1) 3)
    • перечень таблиц; 1) 3)
    • предметный указатель; 1) 2)
    • перечень ссылочных документов; 1)
    • перечень символов и числовых коэффициентов; 1) 2)
    • часть регистрации изменений;
    • лист регистрации изменений.

1) Включается в документ при необходимости
2) Составляется в алфавитном порядке
3) Составляется в порядке возрастания номеров


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