ИНЖИНИРИНГ ЗЛЕКТРОПРИВОДОВ

Виды и содержание программных документов

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

Программные документы содержат сведения, необходимые для разработ­ки, изготовления, сопровождения и эксплуатации программ.

К программным документам относятся (ГОСТ 19.101—87):

Спецификация, содержащая сведения о составе программы и документа­ции на нее;

Ведомость держателей подлинников (05)*, содержащая перечень предприя­тий, на которых хранят подлинники программных документов; текст программы (12) с необходимыми комментариями; описание программы (13), содержащее сведения о ее логической структуре и функционировании;

Программа и методика испытаний (51), содержащая сведения о требовани­ях, подлежащих проверке при испытании программы, а также о порядке и методе их контроля;

Техническое задание, определяющее назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к ней, а также необходимые стадии, сроки разработки и виды испытаний;

Пояснительная записка (81), включающая в себя схему алгоритма, общее описание алгоритма и (или) функционирования программы, а также обосно­вание принятых технических и технико-экономических решений:

Эксплуатационные документы, содержащие сведения для обеспечения функ­ционирования и эксплуатации программы.

К эксплуатационным документам относятся (ГОСТ 19.101—87): ведомость эксплуатационных документов (20), включающая в себя пере­чень эксплуатационных документов на программу;

Формуляр (30), содержащий основные характеристики программы, комп­лектность и сведения об ее эксплуатации;

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

Руководство системного программиста (32), содержащее сведения для про­верки, обеспечения функционирования и настройки программы на условия конкретного применения;

Руководство программиста (33), содержащее сведения для эксплуатации программы;

Руководство оператора (34), содержащее сведения для обеспечения проце­дуры общения оператора с вычислительной системой в процессе выполнения программы;

Описание языка (35), включающее в себя описание его синтаксиса и се­мантики;

Руководство по техническому обслуживанию (46), содержащее сведения для применения тестовых и диагностических программ при обслуживании тех­нических средств.

В зависимости от способа выполнения и характера применения программ­ные документы подразделяются на подлинник, дубликат и копию (ГОСТ 2.102— 68), предназначенные для разработки, сопровождения и эксплуатации про­граммы.

Допускается объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). Необхо­димость такого объединения указывается в техническом задании. При этом объ-

Здесь и далее в скобках указан код вида документа по ГОСТ 19.101—87.

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

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

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

Обозначения программ и документов состоят из групп знаков, разделенных точкой (после кода страны и кода организации-разработчика), пробелом (пос­ле номера редакции документа и кода вида документа), дефисом (после регис­трационного номера и номера документа данного вида) (ГОСТ 19.103—78).

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

А. В.ХХХХХ-ХХ ті--- 1 г -

Общая часть обозначения - Код страны________________________ , , і

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

Номер издания (для программы) Номер редакции (для документа)

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

А. В.ХХХХХ-ХХ XX ХХ-Х

Общая часть обозначения программы і

И программных документов на нее___________________________________ і

Номер редакции документа__________________________________________

Код вида документа________________________________________________

Номер документа данного вида

Номер части документа

Код страны-разработчика и код организации (предприятия)-разработчи - ка присваивают в установленном порядке, номер издания программы или номер редакции документа — в порядке возрастания от 01 до 99, код вида документа — в соответствии с требованиями ГОСТ 19.101—87.