Цели и принципы стандартизации документирования прикладных ПС

В данном разделе излагаются основные цели, методы, принципы организации работ, а также исходные нормативные документы, обеспечивающие модернизации ПС и повышение качества,  и содержание документации. Имеется множество стандартов, процедур, методов, инструментальных средств и типов ОС для разработки и совершенствования документации ПС.

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

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

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

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

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

Технологическая документация в наименьшей и наибольшей степени должна отражать процессы ЖЦ:

1. регламентировать структуру и состав этапов, работ и документов ЖЦ ПС,

2. обеспечивать их адаптацию к характеристикам объекта проектирования внешней и операционной среды,

3. поддерживать и регламентировать процессы организации и планирования реализации ЖЦ конкретных ПС,

4. формулировать выполнение и документирование конкретных работ при проектировании, разработки и сопровождении ПС,

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

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

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

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

3. стандарты и нормативные документы ЖЦ программ, планирование и технологию разработки документации, состав и описание инструментальных средств, автоматизации разработки.

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

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

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

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

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

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

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

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

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

Эксплуатационная документация ПС включает:

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

2. руководство операторов, пользователей, использующих ПС по прямому назначению,

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

4. справочные руководства, по применению ПС.

5. учебное руководство по освоению ПС.