Программные и эксплуатационные документы

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

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

Спецификация - содержит состав программы и документации на нее. Выполняется на стадии рабочего проекта. Является обязательным документом для комплексов и тех компонентов, которые могут иметь самостоятельное применение.
Ведомость держателей подлинников (код вида документа - 05) - содержит перечень предприятий, на которых хранят подлинники программных документов. Выполняется на стадии рабочего проекта. Необходимость составления документа на этапе утверждения технического задания (по согласованию).
Текст программы (код вида документа - 12) - содержит запись программы с необходимыми комментариями. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
Описание программы (код вида документа - 13) - содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
Программа и методика испытаний (код вида документа - 51) - содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость - по согласованию.
Техническое задание - содержит назначение и область применения программы, технические, технико-экономические и специальные требования, предъявляемые к программе, необходимые стадии и сроки разработки, виды испытаний. Выполняется на стадии технического задания и является обязательным документом для комплекса. Необходимость составления технических заданий на компоненты определяется по согласованию с заказчиком.
Пояснительная записка (код вида документа - 81) - содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико-экономических решений.
Выполняется на стадии эскизного и технического проектов. Необходимость - по согласованию.
Эксплуатационные документы - содержит сведения для обеспечения функционирования и эксплуатации программы. Выполняются на стадии рабочего проекта. Необходимость - по согласованию для каждого документа отдельно.

К эксплуатационным относятся следующие документы:

Ведомость эксплуатационных документов (код вида документа - 20) - содержит перечень эксплуатационных документов на программу.
Формуляр (код вида документа - 30) - содержит основные характеристики программы, комплектность и сведения об эксплуатации программы.
Описание применения (код вида документа - 31) - содержит сведения о назначении программы, области применения, применяемых методах, классе решаемых задач, ограничениях для применения, минимальной конфигурации технических средств.
Руководство системного программиста (код вида документа - 32) - содержит сведения для проверки, обеспечения функционирования и настройки программы на условия конкретного применения.
Руководство программиста (код вида документа - 33) - содержит сведения для эксплуатации программы .
Руководство оператора (код вида документа - 34) - содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы .
Описание языка (код вида документа - 35) - содержит описание синтаксиса и семантики языка.
Руководство по техническому обслуживанию (код вида документа - 46) - содержит сведения для применения тестовых и диагностических программ при обслуживании технических средств.

Помимо оговариваемых стандартом, на программу могут выпускаться и другие программные и эксплуатационные документы, им присваиваются коды от 90 до 99. Можно объединять отдельные виды эксплуатационных документов (за исключением ведомости эксплуатационных документов и формуляра). В объединенных документах должны содержаться сведения, которые необходимо включать в каждый объединяемый документ. Обозначение программ и документов состоит из групп знаков, разделенных точками (после кода страны и кода организации-разработчика), пробелами (после номера редакции документа и кода вида документа), дефисами (после регистрационного номера и номера документа данного вида). Программа и ее документ - спецификация имеют следующую структуру обозначения:

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

Кода страны-разработчика и код организации-разработчика присваивают в установленном порядке Регистрационный номер присваивается в порядке возрастания, начиная с 00001 до 99999, для каждой организации-разработчика. Номер издания программы или номер редакции.номер документа данного вида, номер части документа присваиваются в порядке возрастания с 01 до 99. (Если документ состоит из одной части, то дефис и порядковый номер части не указывают.) Номер редакции спецификации и ведомости эксплуатационных документов на программу должны совпадать с номером издания этой же программы.

Оглавление

Содержание раздела