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

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

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

Имеется множество стандартов, процедур, методов, инструментальных средств для разработки и совершенствования документации ПС. Создание и сопровождение документации на ПС должны обеспечивать длительный ЖЦ, мобильность и повторное применение программных информационных компонентов независимо от их первичной разработки.

Предлагается общая структура технологических и эксплутационных документов, объектов и процессов ЖЦ ПС, которая предназначена для использования в индустрии создания ПС. Эта структура содержит номенклатуру документов, которые должны быть использованы во время создания и сопровождения программного средства, для определения, управления и совершенствования сложных комплексов программ. Архитектура и содержание документов на ПС далее не конкретизируется в деталях как их реализовать, а описывается точное содержание, как их документировать.

Документацию на ПС можно разделить на:

1. Технологическую документацию процесса разработки, включающую подробное техническое описание и подготавливаемую для специалистов ведущих проектирование, разработку и сопровождение ПС, детального освоения развитии и корректировки программы и данных на всем ЖЦ.

2. Эксплутационную документацию продукта, объекта и результатов разработки создаваемую для конкретных пользователей ПС и позволяющую им осваивать и квалифицированно применять эти средства для решения конкретных функциональных задач.

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

1. базовые документы определяющие цели и методы применения конкретной версии ЖЦ ПС.

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

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

Технологические документы создаваемых и сопровождаемых прикладных ПС должны определять:

1. структуру и содержание исходных и отчетных документов по этапам разработки, испытаний и сопровождения ПС.

2. логическую структуру программных и информационных документов и БД проекта ПС,

3. спецификацию на внутренние межмодульные интерфейсы компонентов прикладных ПС и на интерфейсы с внешней средой,

4. язык и правила программирования, идентификацию компонентов, комментирование текстов программ и описание данных,

5. методы тестирования и аттестации программных компонентов и ПС в целом.

6. оформление формата и обозначения отчетных и результирующих документов.

Основные виды программных технологических документов и их содержание;

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

• Ведомость держателей подлинников – содержит перечень предприятий, на которых хранят подлинники программных документов. Выполняется на стадии рабочего проекта. Необходимость составления документа на этапе утверждения технического задания (по согласованию).

• Текст программы – содержит запись программы с необходимыми комментариями. Выполняется на стадии рабочего проекта. Необходимость – по согласованию.

• Описание программы – содержит сведения о логической структуре и функционировании программы. Выполняется на стадии рабочего проекта. Необходимость – по согласованию.

• Программа и методика испытаний – содержит требования, подлежащие проверке при испытаниях программы, а также порядок и методы их контроля. Выполняется на стадии рабочего проекта. Необходимость – по согласованию.

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

• Пояснительная записка – содержит схему алгоритма, общее описание алгоритма и /или функционирования программы, а также обоснование принятых технических и технико–экономических решений. Выполняется на стадии эскизного и технического проектов. Необходимость – по согласованию.

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

Основные виды эксплуатационных документов и их содержание:

• Ведомость эксплуатационных документов – содержит перечень эксплуатационных документов на программу.

• Формуляр – содержит основные характеристики программы, комплектность и сведения об эксплуатации программы.

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

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

• Руководство программиста – содержит сведения для эксплуатации программы.

• Руководство оператора – содержит сведения для обеспечения процедуры общения оператора с вычислительной системой в процессе выполнения программы. Это руководство пользователей, использующих ПС по прямому назначению

• Описание языка – содержит описание синтаксиса и семантики языка.

• Руководство по техническому обслуживанию – содержит документацию сопровождения ПС, включая руководство по сопровождению и модификации программ и информации БД содержит сведения для применения тестовых и диагностических программ при обслуживании технических средств.

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