Рекомендации к оформлению текстовой части программных документов

Программный документ состоит из следующих условных частей:

титульной;

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

основной;

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

Титульная часть состоит из листа утверждения и титульного листа.

Лист утверждения не входит в общее число листов документа­ции. На листе утверждения и на титульном листе указываются назва­ние программы, вид программного документа и обозначение программ­ного документа.

Структура обозначения программы и спецификации на нее:

A. B. XXXXX-XX,

где символы до первой точки - код страны, символы до второй точки - код организации разработчика (код ВятГУ - ТПЖА), следую­щие пять символов - регистрационный номер в соответствии с класси­фикатором РФ, два символа после тире номер издания для программы или номер редакции для документа. Допускается присваивать регист­рационный номер в порядке возрастания для каждой организации-разработчика.

В обозначение программ и спецификаций, разработанных по зада­нию кафедры РЭС на курсовое или дипломное проектирование, реко­мендуется код страны не указывать, а регистрационный номер включа­ет в себя следующие компоненты:

первые две цифры являются кодом кафедры - 12;

третья цифра - порядковый номер курса - (1...5);

последние две цифры - номер варианта на задании.

Обозначение программ и спецификаций, разработанных в ходе дипломного проектирования по заданию предприятий и организаций, необходимо формировать согласно принятых там ОСТ, например ОСТ 11 091.905-78:

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

A. B. XXXXX-XX XX XX-X

Общая часть обозначения | | | | |

программы и программных | | | | |

документов на нее [--------------] | | | | |

Номер редакции документа [-------] | | | |

Код вида документа [-----------------------------] | | |

Номер документа данного вида [----------------------] | |

Номер части документа [---------------------------------] | (если документ состоит из одной части, то дефис и порядковый номер части не указывают).

Информационная часть состоит из двух элементов: аннотации и содержания (перечня).

Аннотация представляет собой краткое изложе­ние всего программного документа. Ее размещают на отдельной стра­нице с заголовком АННОТАЦИЯ.

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

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

Внесение любого изменения в документ производится согласно извещению об изменении.

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

Все программные документы выполняются на листах формата А4 по форме 1 или формата А3 по форме 2 (ГОСТ 2.301-68). При автоматизи­рованном способе выполнения документа размеры форматов определяют­ся применяемыми техническими средствами по ГОСТ 2.004-79.

Программные документы делятся на части не ниже уровня раздела.

РЕКОМЕНДАЦИИ ПО СОСТАВЛЕНИЮ ДОКУМЕНТА"ОПИСАНИЕ ПРОГРАММЫ"

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

обозначение структурного элемента (номер раздела и т.п.);

наименование структурного элемента;

адрес структурного элемента на носителе данных (номер страни­цы, номер файла и т.п.).

Основная часть документа должна содержать следующие разделы:

общие сведения;

функциональное назначение;

описание логической структуры;

используемые технические средства;

вызов и загрузка;

входные данные;