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


Спецификация


Спецификация является основным программным документом для компонентов, применяемых самостоятельно, и для комплексов.

Форма спецификации приведена на рисунке ниже:.

Спецификация в общем случае должна содержать разделы:

  • документация;
  • комплексы;
  • компоненты.
Аннотацию и содержание можно не включать в документ.

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

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

Графы спецификаций заполняют следующим образом:

  • в графе "Обозначение":
    • в разделе "Документация" - обозначения записываемых документов программы;
    • в разделе "Комплексы" - обозначения спецификаций комплексов, входящих в данный комплекс;
    • в разделе "Компоненты" - обозначения основных программных документов компонентов;
  • в графе "Наименование":
    • в разделе "Документация" - наименование и вид документа для документов на данную программу; полное наименование программы, наименование и вид документа для заимствованных документов;
    • в разделах "Комплексы" и "Компоненты" - полное наименование программы, наименование и вид документа;
  • в графе "Примечание" - дополнительные сведения, относящиеся к записанным в спецификации программам.

При отсутствии места в графе "Примечание" допускается записывать только порядковые номера примечаний, а текст примечаний - в конце соответствующих разделов спецификации. Можно текст примечаний записывать на последних листах спецификации без граф с проставлением порядкового номера примечания.

В графе "Обозначение" запись производят в одну строку. В остальных графах спецификации записи допускаются в несколько строк.

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


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