Рассмотрим применение стандартов на примере описания процесса «создание технической документации программного продукта» с указанием всех ГОСТов, применяемых в данной предметной области (рис.1).

Вводная часть

Предприятие с условным названием «ПРОГРАММиК» занимается созданием и сопровождением программных продуктов для коммерческого использования. К основным бизнес-процессам (БП) предприятия относятся [4, 5, 6]:

• Анализ и согласование требований заказчика
• Формирование и согласование технического задания (ТЗ) на выполнение разработки
• Заключение договора на выполнение разработки
• Выполнение разработки (проектирование и программирование)
• Оценка качества выполнения разработки (тестирование)
• Создание сопроводительной документации (документирование)
• Внедрение разработки
• Сопровождение разработки (исправления, доработка, консультирование по работе и т.д.)

Детально рассмотрим БП «Создание сопроводительной документации (документирование)». Процесс заключается в создании техническим писателем документа (документов), описывающих разработку для возможности работы с ней определенных категорий клиентов-потребителей:

• системных администраторов (документы «Руководство администратора», «Руководство системного администратора», «Руководство по установке»)
• программистов (документы «Руководство программиста», «Структура базы данных», «Application Programming Interface», «Функциональная спецификация»)
• пользователей (документ «Руководство пользователя»)

Этапы создания документации:

1. Постановка задачи.
2. Получение входных данных.
3. Документирование.
4. Рецензирование документации.
5. Проверка документации.

1. На этапе постановки задачи разработчик/менеджер проекта составляет запрос на проведение работ в системе ведения проектов JIRA (регулируется внутренним регламентом компании) на выполнение документирования техническим писателем. В заявке содержится минимальная информация по проделываемой работе: срок, приоритет, тип запроса (новый компонент, задача, подзадача, исправление) и краткое описание.

2. На этапе получения входных данных технический писатель запрашивает (самостоятельно находит) входные данные, необходимые для решения запроса. Иногда необходимые данные указывают непосредственно в запросе, тогда данный этап пропускается. В качестве входных данных могут выступать [7, 8, 9]:

• текст программы (регулируется стандартом ГОСТ 19.401-78 «Единая система программной документации. Текст программы. Требования к содержанию и оформлению»)
• техническое задание (регулируется стандартом ГОСТ 19.201-78 “Единая система программной документации. Техническое задание. Требования к содержанию и оформлению”)
• техническая или функциональная спецификация (регулируется стандартом ГОСТ 19.202-78 «Единая система программной документации. Спецификация. Требования к содержанию и оформлению»)

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

3. На этапе описания разработки (документирования)  выполняется переработка входной информации и создается описание на техническом языке, доступном для понимания конечного пользователя. Технический писатель при создании описания руководствуется следующими нормативными документами:

• ГОСТ Р ИСО/МЭК 15910-2002 «Информационная технология. Процесс создания документации пользователя программного средства» (для документа «Руководство пользователя»)
• ГОСТ 19.202-78 «Единая система программной документации. Спецификация. Требования к содержанию и оформлению» (для документа «Функциональная спецификация»)
• ГОСТ 19.504-79 «ГОСТ 19.202-78 «Единая система программной документации. Руководство программиста. Требования к содержанию и оформлению» (для документа «Руководство программиста»)
• ГОСТ 19.603-78 «Единая система программной документации. Общие правила внесения изменений» (для внесения изменений в существующую документацию)
• ГОСТ Р ИСО 9127-94 «Системы обработки информации. Документация пользователя и информация на упаковке для потребительских программных пакетов» (для документа «Руководство по установке»)
• ГОСТ 18421-93 «Аналоговая и аналогово-цифровая вычислительная техника. Термины и определения» (для обеспечения единообразия используемой в документации терминологии)

Также для описания разработки используются внутренние стандарты, разработанные компанией (регламент описания документов «Структура базы данных», «Application Programming Interface» и т.д.).

4. На этапе рецензирования документации выполняется проверка текста документации и внесение соответствующих корректировок. Разделяют внутреннее (со стороны коллеги – технического писателя) и внешнее (со стороны разработчика) рецензирование. Процесс рецензирования регулируется внутренними регламентами отдела технической документации и взаимодействия между отделами.

5. На этапе проверки качества и соответствия технической документации руководителем отдела документации (старшим техническим писателем) выполняется проверка выполненной работы. Основным документом, регламентирующим деятельность руководителя отдела технической документации, является стандарт ГОСТ Р ИСО/МЭК ТО 9294-93 «Информационная технология. Руководство по управлению документированием программного обеспечения».