Виды программной документации

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

В мировой практике выделяют 5 типов программной документации:

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

В российских компаниях с государственным участием распространена практика разработки программной документации в соответствии с требованиями ЕСПД. Для коммерческого рынка и компаний, более тесно сотрудничающих с иностранными заказчиками, разработка часто ведется в корпоративном стиле. Реже разработка осуществляется по требованиям международных стандартов (ISO, IEEE Std).

Рассмотрим особенности разработки программной документации по ГОСТ 19.101-77. Размер программы может быть разным, потому для удобства работы с ней ее разбивают на компоненты. Компонент представляет собой унитарную программу, выполняющую законченную функцию. При объединении нескольких компонентов в систему формируются программные комплексы.


Какие виды программной документации существуют?

• спецификация,
• техническое задание (ТЗ),
• ведомость держателей подлинников (ДП),
• текст программы,
• описание программы,
• программа и методика испытаний,
• пояснительная записка,
• эксплуатационная документация.

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

Техническое задание – это основной вид документа с требованиями к программе, который определяет цель ее разработки и область применения. ТЗ может быть составлено на основе различных стандартов (ГОСТ 34, 19, IEEE STD 830-1998, ISO/IEC/ IEEE 29148-2011).

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

Текст программы – это вид документа, содержащий исходный текст/код программы (source code). Данная запись включает комментарии, необходимые для корректного функционирования программы. 

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

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

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

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

• ведомость эксплуатационных документов (документы на программу и на ее составные части);
• формуляр (приложением к формуляру может быть журнал учета);
• описание применения;
• руководство системного программиста;
• руководство программиста;
• руководство оператора;
• описание языка (общие сведения и элементы языка);
• руководство по техническому обслуживанию.

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