Описание частей программного документа
Опубликовано 11 Мар 2009 в 0:50
Информационная часть содержит аннотацию и содержание. В аннотации приводятся сведенья о назначении документа и краткое изложение его основной части. Содержание включает перечень записей о структурных элементах документа, его основной части, куда входят номер раздела, подраздела и т.д., наименование и адрес структурного элемента (страница, номер файла).
Состав и структура основной части программного документа устанавливается стандартами ЕСПД на соответствующие документы. Например:
ГОСТ 19.402-78. « Описание программы» должен содержать следующие разделы:
• общие сведения;
• функциональное назначение;
• описание логической структуры;
• используемые технические средства;
• вызов и загрузка;
• входные данные;
• выходные данные.
ГОСТ 19.401-78. «Текст программы». состоит из одного или нескольких разделов. Каждый раздел реализуется одним из типов символической записи:
• на исходном языке;
• на промежуточных языках;
• машинные коды.
ГОСТ 19.502-78. «Описание применения», текст документа должен состоять из:
• назначения программы;
• условия применения;
• описание задачи;
• входные и выходные данные.
ГОСТ 19.503-79 «Руководство системного программиста» должно содержать:
• общие сведения о программе;
• структура программы;
• настройка программы;
• проверка программы;
• дополнительные возможности;
• сообщения системному программисту.
ГОСТ 19.504-79. «Руководство программиста» должно содержать:
• назначение и условия применения программы;
• характеристики программы;
• обращение к программе;
• входные и выходные данные;
• сообщения программисту.
ГОСТ 19.505-79. «Руководство оператора» должно содержать:
• назначение программы;
• условия выполнения программы;
• выполнение программы;
• сообщения оператору.
ГОСТ 19.508-79. «Руководство по техническому обслуживанию» должно содержать:
• введение;
• общие указания;
• требования к техническим средствам;
• описание функций.