7.3 Программы и программные документы

Разработка программ и программной документации регламентируется стан­дартами ЕСПД вне зависимости от назначения и области их применения.

Виды программных документов, разрабатываемых на разных стадиях проек­тирования, и их коды, в соответствии с ГОСТ 19.101, приведены в таблице 7.1.

Компонент — это программа, рассматриваемая как единое целое, выпол­няющая законченную функцию и применяемая самостоятельно или в составе комплекса.

Комплекс — это программа, состоящая из двух или более компонентов и (или) комплексов, выполняющих взаимосвязанные функции.

Таблица 7.1 — Виды программных документов по ГОСТ 19.101

Код вида до­кумента	Вид документа	Стадии разработки
		Эскизный проект	Технический проект	Рабочий проект
				Компо­нент	Ком­плекс
—	Спецификация	—	—	Ø	•
05	Ведомость держателей под­линников	—	—	—	О
12	Текст программы	—	—	О	О
13	Описание программы	—	—	О	О
20	Ведомость эксплуатацион­ных документов	—	—	О	О
30	Формуляр	—	—	О	О
31	Описание применения	—	—	О	О
32	Руководство системного программиста	—	—	О	О
33	Руководство программиста	—	—		О
34	Руководство оператора	—	—	О	О
35	Описание языка	—	—	О	О
46	Руководство по техниче­скому обслуживанию	—	—	О	О
51	Программа и методика ис­пытаний	—	—	О	О
81	Пояснительная записка	О	О	—	—
90—99	Прочие документы	О	О	О	О

Условные обозначения

Ø — документ обязательный;

• — документ обязательный для компонентов, имеющих самостоятельное применение;

О — необходимость составления документа определяется на этапе разра­ботки и утверждения ТЗ;

— — документ не составляют.

Каждый программный документ должен состоять из следующих условных частей:

• титульной;

• информационной;

• основной;

• регистрации изменений.

Структура обозначения программ и программных документов установлена ГОСТ 19.103.

Требования к программным документам, выполняемым печатным способом, даны в ГОСТ 19.106, а к тексту программы — в ГОСТ 19.401.

Титульная часть программного документа состоит из листа утверждения (ЛУ) и титульного листа (ТЛ), выполняемых на бумаге формата А4. Формы ЛУ и ТЛ регламентированы ГОСТ 19.104.

Информационная часть программного документа состоит из двух элемен­тов: аннотации и содержания (перечня). Аннотация представляет собой краткое изложение всего программного документа. Ее размещают на отдельной (прону­мерованной) странице с заголовком Аннотация (без кавычек и без нумерации как раздела). В содержание входит перечень записей (например, в виде оглавле­ния) о структурных элементах основной части документа. Каждая такая запись содержит: обозначение структурного элемента (номер раздела, подраздела и т. д.); наименование структурного элемента; адрес структурного элемента на но­сителе данных (например, номер страницы, номер файла и т. п.). Содержание размещают после аннотации на отдельной странице с заголовком Содержание (без кавычек и без нумерации как раздела). Правила оформления информацион­ной части установлены в ГОСТ 19.105.

Основная часть программного документа содержит текст документа (с на­именованием разделов), рисунки, таблицы и т. п. В основную часть включают: перечень терминов и определений, перечень сокращений, приложения, предмет­ный указатель и перечень ссылочных документов. Оформление основной части программного документа регламентировано в ГОСТ 19.105.

Часть регистрации изменений фиксирует внесение (удаление) нового из­менения. Оформление регламентирует ГОСТ 19.603.

Структура обозначения программы и ее программного документа — специ­фикации по ГОСТ 19.103 следующая:

А.В. ХХХХХ — XX

где А — код страны;

В — код организации разработчика;

ХХХХХ — регистрационный номер в соответствии с классификатором про­грамм;

XX— номер издания программы.

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

XX— код вида документации;

XX— номер документа данного вида;

X— номер части документа, если они есть.

Программная документация в ДП (ДР) в учебном заведении может быть оформлена следующим образом:

• полностью в соответствии с требованиями стандартов ЕСПД, т. е. оформ­ляется как отдельная часть или раздел пояснительной записки;

• включением в ПЗ отдельных программных документов, например, схемы алгоритма программы, текста программы и выполненные, в соответствии с требованиями стандартов ЕСПД, включаются в ПЗ в виде приложений и иллюстраций (рисунки).

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

Выполнение и оформление составных частей регламентируются следующи­ми стандартами.

ГОСТ 19.103 устанавливает структуру обозначения программ и программ­ных документов;

ГОСТ 19.104 устанавливает правила оформления титульной части про­граммного документа;

ГОСТ 19.105 устанавливает правила оформления информационной и основ­ной части программного документа;

ГОСТ 19.106 устанавливает требования к программным документам, выпол­няемым печатным способом;

ГОСТ 19.603 регламентирует оформление регистрации изменений в про­граммном документе;

ГОСТ 19.701 (взамен ГОСТ 19.002 и ГОСТ 19.003) устанавливает в соответ­ствии с международным стандартом ICO5807-85 правила применения условных обозначений для схем: данных, программ, работы системы, взаимодействия про­грамм и ресурсов системы.

Каждый программный документ по составу и структуре оформляется в соот­ветствии с требованиями конкретного стандарта ЕСПД. Например,

ГОСТ 19.202 устанавливает форму и порядок основного обязательного доку­мента — спецификации;

ГОСТ 19.401 устанавливает требования к содержанию обязательного про­граммного документа — текст программы,

ГОСТ 19.402 устанавливает требования к программному документу — опи­сание программы;

ГОСТ 19.404 устанавливает требования к содержанию программного доку­мента — пояснительной записки.

Допускается внутривузовское обозначение программных документов.

В ПГАТИ принята следующая структура обозначения программных доку­ментов:

ПГАТИ.ХХХХХХ.ХХХ-ХХ

где ХХХХХХ — специальность и кафедра, например 2007 и индекс кафедры 34;

XXX— порядковый регистрационный номер документа;

XX— код документа (см. таблицу 7.1 пособия).

Устанавливаются три способа выполнения программных документов: 1) ма­шинописный (допускается и рукописный); 2) машинный способ (на ЭВМ); 3) ти­пографский.

Каждый программный документ оформляется в соответствии с требования­ми стандартов ЕСПД, например: спецификация (ГОСТ 19.202); описание про­граммы (ГОСТ 19.402); пояснительная записка (ГОСТ 19.404) и др.