Требования к содержанию и оформлению текстовых программных документов

Отдельные виды текстовых программных документов выполняют в соответствии с ГОСТ 19.201-78, 19.202-78, 19.301-78, 19.401-78, 19.402-78, 19.404-78, 19.502-78, 19.503-79, 19.504-79, 19.505-79.

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

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

Основная часть спецификации содержит текст, разбитый на графы:

• «Обозначение» ‑ для обозначений основных и дополнительных программных документов данного комплекса, а также входящих в него комплексов и компонентов;

• «Наименование» ‑ для наименований разработанных и заимствованных документов на данный комплекс, полных наименований программы и основного документа для входящих комплексов и компонентов;

• «Примечание» ‑ для дополнительных сведений, относящихся к записанным документам и программам.

Ширина граф, соответственно ‑ 80, 70 и 30 мм, высота строк – 7..10 мм.

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

В раздел «Документация» записывают программные документы, разработанные на данную программу (комплекс), кроме спецификации и технического задания, в порядке возрастания кода вида документа, входящего в обозначение.

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

5.2. Техническое задание

Техническое задание на разработку учебных программных изделий оформляется в виде «Задания на курсовое (дипломное) проектирование» по соответствующим формам и правилам и включается в пояснительную записку листом со вторым порядковым номером.

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

В разделе «Перечень графического материала» необходимо указывать предварительный состав программной документации, подлежащей разработке.

5.3. Текст программы

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

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

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