Документирование программного обеспечения Стандарты документирования

Основу отечественной нормативной базы в области

документирования ПС составлял комплекс стандартов

Единой системы программной документации (ЕСПД ГОСТ 19).

Стандарты комплекса ГОСТ 34 на создание и развитие автоматизированных систем (АС) — обобщенные, но воспринимаемые как весьма жесткие по структуре ЖЦ и проектной документации.

Государственные стандарты РФ (ГОСТ Р ИСО/МЭК), разработанные на основе прямого применения международных стандартов (ISO/IEC). Это самые "свежие" по времени принятия стандарты.

Следует отметить, что все упомянутые стандарты носят рекомендательный характер. В

соответствии с Законом РФ "О стандартизации" эти стандарты становятся обязательными на контрактной основе — то есть при ссылке на них в договоре на

разработку (поставку) ПС.

Документирование программного обеспечения Стандарты документирования. Зачем и что?

Зачем:

1.Выбор модели жизненного цикла ПО.

2.Определение типов и содержания документов.

3.Определение качества документов.

4.Определение форматов документов.

5.Определение системы обозначения документов. Какие:

1.Стандарты на процесс создания документации. Определяют способ создания технической документации.

2.Стандарты на документ. Определяют структуру и внешний вид документов.

3.Стандарты на обмен документами. Гарантируют совместимость всех электронных версий документов.

Единая система программной документации (ЕСПД). Назначение.

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

1.2. В стандартах ЕСПД устанавливают требования,

регламентирующие разработку, сопровождение, изготовление и эксплуатацию программ, что обеспечивает возможность:

унификации программных изделий для взаимного обмена программами и применения ранее разработанных программ в новых разработках;

снижения трудоемкости и повышения эффективности

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

автоматизации изготовления и хранения программной документации.

Единая система программной документации (ЕСПД). Область распространения и состав.

2.1. Правила и положения, установленные в стандартах ЕСПД,

распространяются на программы и программную документацию

для вычислительных машин, комплексов и систем независимо от их назначения и области применения.

2.2. В состав ЕСПД входят:

основополагающие и организационно-методические стандарты;

стандарты, определяющие формы и содержание программных документов, применяемых при обработке данных;

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

2.3. Разработка организационно-методической документации, определяющей и регламентирующей деятельность организаций по разработке, сопровождению и эксплуатации программ, должна проводиться на основе стандартов ЕСПД.

ЕСПД.

Недостатки.

Большая часть стандартов ЕСПД морально устарела. К числу основных недостатков ЕСПД можно отнести:

ориентацию на единственную, "каскадную" модель жизненного цикла (ЖЦ) ПС;

отсутствие четких рекомендаций по документированию характеристик качества ПС;

отсутствие системной увязки с другими действующими отечественными системами стандартов по ЖЦ и документированию продукции в целом, например, ЕСКД;

нечетко выраженный подход к документированию ПС как товарной продукции;

отсутствие рекомендаций по самодокументированию ПС, например, в виде экранных меню и средств оперативной помощи пользователю ("хелпов");

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

ЕСПД.

Возможность применения.

Тем не менее, многие стандарты ЕСПД могут с пользой применяться в практике документирования ПС. Эта позиция основана на следующем:

стандарты ЕСПД вносят элемент упорядочения в процесс документирования ПС;

предусмотренный стандартами ЕСПД состав программных документов вовсе не такой "жесткий", как некоторым кажется: стандарты позволяют вносить в комплект документации на ПС дополнительные виды

стандарты ЕСПД позволяют мобильно изменять структуры и содержание установленных видов ПД исходя из требований заказчика и пользователя.

многие заказчики «привыкли» к ЕСПД, как основе документирования.

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

ЕСПД.

Состав.

Группа Наименование группы

--------------------------------------------------------------------------------------------

0 Общие положения

1 Основополагающие стандарты

2 Правила выполнения документации разработки

3 Правила выполнения документации изготовления

4 Правила выполнения документации сопровождения

5 Правила выполнения эксплуатационной документации

6 Правила обращения программной документации

7 8 Резервные группы

9 Прочие стандарты

ГОСТ 19.101-77 ЕСПД.

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

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

ЕСПД.

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

ГОСТ 19.201-78 ЕСПД. Техническое задание. Требования к содержанию и оформлению.

ГОСТ 19.402-78 ЕСПД. Описание программы.

ГОСТ 19.404-79 ЕСПД. Пояснительная записка,

ГОСТ 19.502-78 ЕСПД. Описание применения,

ГОСТ 19.503-79 ЕСПД. Руководство системного программиста,

ГОСТ 19.504-79 ЕСПД. Руководство программиста,

ГОСТ 19.505-79 ЕСПД. Руководство оператора.

ГОСТ 19.508-79 ЕСПД. Руководство по техническому обслуживанию. Требования к содержанию и оформлению.

ГОСТ 19.301-79 ЕСПД. Программа и методика испытаний.