4.3. Общие требования к структуре программных документов

4.3.1. Программный документ состоит из следующих условных частей: титульной (титульный лист), информационной (аннотация и содержание) и основной.

Титульный лист разрабатывается на каждый программный документ, за исключением технического задания на курсовое (дипломное) проектирование. Допускается также не разрабатывать титульный лист на спецификацию, а также на схему алгоритма (программы, данных, системы), если они располагаются на одном-двух листах ‑ в этом случае основная надпись выполняется по форме и правилам, предусмотренным ЕСКД.

В аннотации приводят сведения о назначении документа и краткое изложение его основной части, объем аннотации – не более 10 строк текста (для пояснительной записки – не более 20 строк). Содержание включает перечень записей о структурных элементах (разделы, подразделы, для текста программы – модули) основной части документа. Информационная часть не разрабатывается для технического задания, спецификации и схем алгоритмов (данных, программ, системы). Допускается также не разрабатывать информационную часть для программных документов, оформленных в виде приложений к пояснительной записке. Разделы АННОТАЦИЯ и СОДЕРЖАНИЕ не нумеруют.

Рекомендуемая структура основной части (состав нумеруемых разделов) программных документов различных видов определена ниже. В зависимости от особенностей программы допускается объединять отдельные разделы и вводить дополнительные, в названиях разделов опускать слово «программа» или заменять его наименованием программы. Степень детализации излагаемой в соответствующих разделах информации зависит от назначения разработки и комплектности разрабатываемых программных документов. Содержание разделов можно иллюстрировать таблицами, схемами, поясняющими примерами, экранными формами, которые размещаются либо в тексте раздела, либо (при большом их объеме) в виде отдельных иллюстрирующих приложений с соответствующими заголовками.

4.3.2. Программные документы, содержащие в основном сплошной текст, выполняются в соответствии с требованиями комплекса стандартов ЕСКД к оформлению текстовых документов. Для выделения отдельных понятий (символические записи переменных, команд, режимов и т.п.) допускается изменять интервал между словами, использовать различные шрифты и абзацные отступы, применять подчеркивания. Отдельные фрагменты программ в тексте документа рекомендуется записывать и нумеровать по правилам, установленным для формул. Сведения о структуре (виде) выходной информации (например, экранные формы) оформляют в виде рисунков по установленным правилам.

4.3.3. Отдельные программные документы учебных проектов выполняются, как правило, в виде приложений к основному документу – пояснительной записке, располагаемых после иллюстрирующих приложений (см. п.4.3.1). На титульном (первом) листе приложения в правом верхнем углу указывается слово ПРИЛОЖЕНИЕ (с порядковым номером, если их несколько), нумерация листов в иллюстрирующих приложениях – сквозная с основным документом, в приложениях – документах – самостоятельная. Все приложения и их наименования (заголовки) перечисляются в информационной части (содержании) пояснительной записки, а в основной ее части должны присутствовать ссылки на каждое из них.