Документация на программное обеспечение: что входит и как оформить
Документация на программное обеспечение – это не просто формальность, а системный инструмент, который делает разработку управляемой и воспроизводимой. Она помогает командам сохранять ясность решений, соответствовать требованиям ГОСТ 34/19 и ISO/IEEE и готовить проекты к сертификации. В статье разберём, какие документы формируются на разных стадиях жизненного цикла и как выстроить структуру документации, чтобы она работала на устойчивость бизнеса, а не мешала развитию.
Проектная и техническая документация – неотъемлемая часть жизненного цикла ПО. В Etence мы используем системный подход, чтобы обеспечить управляемость, масштабируемость и прозрачность решений для команд и заказчиков.
В статье описываем как организовать документацию на ПО: какие документы формировать, зачем они нужны и каким стандартам (ГОСТ 34/19, ISO/IEEE) они соответствуют.
Почему документация имеет значение
Без структурированной документации растут риски неясности, дублирования и потери управляемости – критично для сложных, распределённых и долгих проектов. Документация – это инструмент:
- фиксации архитектурных и организационных решений;
- воспроизводимости при масштабировании и передаче проекта;
- соблюдения регуляторных и требований ГОСТ;
- прозрачности ролей, ответственности и критериев качества.
Подробнее о подходе:
Как в Etence организована документация на программное обеспечение
Документы классифицируются по стадиям жизненного цикла (ЖЦ) и назначению. Мы применяем гибкость: для небольших проектов – укрупнённые шаблоны, для государственных и инфраструктурных – полная детализация.
Документы стадии инициации проекта
Назначение: формулировка замысла, обоснование проекта, определение границ и рисков.
- Концепция проекта (Concept Note) – идея, цели, проблемы, ожидаемые эффекты; ключевые метрики. ГОСТ 34.201–89, Vision Document.
- Предварительный обзор проекта (Initial Review) – риски, ограничения, допущения, зависимости; критерии “go/no-go”.
- Обоснование целесообразности (Feasibility Study) – техническая и ресурсная реализуемость; альтернативы и TCO. ISO/IEC 15288.
- Бизнес-обоснование (Business Case) – экономика, стратегия, выгоды/затраты, риски и сценарии. PMBOK.
- Эскизный проект (ЭП, Preliminary Design, High-Level Concept, Conceptual Architecture, BRD) – архитектурная концепция, состав и структура, ключевые модули, интеграции и принципы построения. ГОСТ 34.201–89; соответствует High-Level Design (HLD).
- Запрос информации (RFI) – для сравнения решений и выбора подрядчиков; не формализован ГОСТ, практика PMBOK.
- Техническое задание (ТЗ, Requirements Specification) – фиксирует цели, функции, состав работ, архитектурные и ограничительные требования. ГОСТ 34.602–89, ISO/IEC/IEEE 29148 (вместо устаревшего IEEE 830).
Архитектурные и системные документы
Назначение: фиксируют архитектуру, состав, структуру программных компонентов, а также интерфейсы и данные, передаваемые между ними. Используются на стадии проектирования и при передаче проекта в разработку. Формируют основу высокоуровневого проектирования (High-Level Design, HLD) и служат входом для создания рабочей документации (РД) / Low-Level Design (LLD).
- Технический проект (ТП, Technical Design, HLD) – формализует архитектуру, функциональные и нефункциональные требования, логику, структуру и взаимодействия. ГОСТ 34.603–92; ISO/IEC/IEEE 42010; SRS по ISO/IEC/IEEE 29148.
- Описание структуры программы (Program Structure Description) – иерархия компонентов, назначение, состав и связи (граница HLD/LLD); схемы и таблицы модулей. ГОСТ 19.402–78, ISO/IEC/IEEE 42010. Для внешних зависимостей — SBOM (SPDX/CycloneDX); управление OSS — OpenChain ISO/IEC 5230.
- Рабочая документация (РД, Low-Level Design / Implementation Specification) – детализация ТП до уровня реализации, настройки и сопровождения. ГОСТ 19.402–78; IEEE 1016 (Software Design Description).
- Описание протокола взаимодействия программ – интерфейсы между программами/модулями/компонентами. ГОСТ 19.502; ISO/IEC/IEEE 42010; практики OpenAPI, gRPC IDL, GraphQL.
- Описание входных и выходных данных (Input/Output Data Description) – параметры, поля, типы данных, ограничения и форматы; словарь данных. ГОСТ 19.503; ISO/IEC 11179 (Data Dictionary).
Функциональные и интерфейсные спецификации
- Описание функциональных характеристик ПО – внутренняя логика, модули, параметры, алгоритмы; часть SRS. ГОСТ 19.101.
- Описание пользовательских интерфейсов (User Interface Specification) – экраны, элементы, поведение, UX. ГОСТ 19.505; ISO 9241 / ISO/IEC 25062.
Реализация, сборка и разработка
Назначение: обеспечить воспроизводимость и стандарты разработки.
- Инструкция по установке и развёртыванию (Build Guide) – шаги установки, окружения, зависимости, команды CI/CD. ГОСТ 19.506.
- Руководство по разработке (Development Guide) – процессы Git, коммиты, ревью, правила изменений; стандарты ветвления и код-ревью. ISO/IEC/IEEE 26515.
- Описание исходного кода (Source Code Structure) – структура проекта, особенности реализации, стандарты кода и статический анализ. IEEE 1016.
Испытания и проверка
- Программа и методика испытаний (ПМИ) – подход к тестированию, критерии приёмки, условия и этапы. ГОСТ 19.301; ГОСТ 34.601; ISO/IEC/IEEE 29119.
- Протоколы испытаний – результаты по ПМИ: проведённые тесты, итоги, отклонения, даты и подписи. Сопровождающие записи в рамках ISO/IEC 12207.
Эксплуатация и сопровождение
Назначение: эксплуатация, обновления, сопровождение.
- Руководство пользователя (User Manual) – инструкции, сценарии, подсказки, описание интерфейса. ГОСТ 19.505.
- Руководство администратора (Admin Manual) – установка, настройка, резервное копирование, безопасность и мониторинг. ГОСТ 19.506.
- Регламент сопровождения (Support Plan) – жизненный цикл поддержки, управление инцидентами и изменениями, обновления, роли. ISO/IEC 14764 / ITIL.
- Документация по инфраструктуре (Infrastructure Guide) –репозитории, CI/CD, артефакты, зеркала, среды и сервера.
- Описание процессов жизненного цикла программного обеспечения (Lifecycle Managment Plan) – этапы разработки, обновлений, сопровождения и развития. ISO/IEC 12207; ГОСТ 34.201.
Подробнее об эксплуатационной документации — в отдельной статье.
Паспорта и регистрация
- Паспорт системы (System Passport) – версия, сборка, состав, платформа, совместимости. ГОСТ 2.601.
- Описание программного продукта (Product Description) – для реестра российского ПО (по приказам Минцифры и методическим материалам ЦКИТ).
- Механизмы лицензирования и поставки – по ISO/IEC 19770; оформляются как часть сопровождающей документации (включая активацию и учёт лицензий).
ГОСТ 34 и ГОСТ 19: стандарты проектной документации на программное обеспечение
ГОСТ 34 и ГОСТ 19 – основа формализации проектной документации. Мы применяем их адаптированно: сохраняем структуру и смысл, избегая избыточной формализации.
ГОСТ 34: жизненный цикл автоматизированных систем
- ГОСТ 34.201–89 – стадии проектирования и состав проектной документации (ТЗ, ТП, РП, ПМИ, эксплуатация).
- ГОСТ 34.201.4–89 – требования к эксплуатационной документации.
- ГОСТ 34.602–89 – структура ТЗ: цели, требования, ограничения, порядок приёмки.
- ГОСТ 34.603–92 – структура технического проекта.
- ГОСТ 34.601–90 – программа и методика испытаний (ПМИ).
ГОСТ 34 применяется при проектировании архитектуры, фиксации требований, передаче проектов на поддержку.
ГОСТ 19: документация на программное обеспечение
- ГОСТ 19.101 – общие требования к программной документации: структура, реквизиты, оформление.
- ГОСТ 19.104 – состав программной документации.
- ГОСТ 19.102 – классификация программных документов по стадиям ЖЦ и ролям.
- ГОСТ 19.103 – ведомость программных документов.
- ГОСТ 19.201 – пояснительная записка
- ГОСТ 19.301 – программа и методика испытаний
- ГОСТ 19.402 – структура программы
- ГОСТ 19.503 – входные и выходные данные
- ГОСТ 19.505/506 – руководства пользователя и администратора
- ГОСТ 19.502 – протокол взаимодействия
- ГОСТ 19.701 – формуляр программы, используется при регистрации ПО.
ГОСТ 19 актуален для формализации внутренних модулей, пользовательских инструкций и проектной части программного обеспечения.
Международные стандарты: ISO и IEEE
Наряду с российскими ГОСТами, мы в Etence ориентируемся на международные стандарты проектирования и сопровождения ПО:
ISO/IEC 25010 – модель качества ПО (надёжность, безопасность, удобство и др.).
ISO/IEC/IEEE 29119 – стандарты тестирования (планы, кейсы, отчётность).
ISO/IEC 27001/27034 – управление ИБ и безопасность приложений; применимо при работе с защищаемой информацией.
ISO/IEC 12207 – процессы ЖЦ ПО: разработка, сопровождение, оценка.
ISO/IEC/IEEE 42010 – описание архитектуры программных и системных решений.
IEEE 1016 – Software Design Description (описание проектных решений).
SBOM и IETF – ведение перечня компонентов и зависимостей (SPDX/CycloneDX); рекомендации IETF и отраслевые практики.
Эти стандарты особенно важны при работе с интеграцией в сложные экосистемы, формализации архитектуры и построении устойчивых процессов разработки.
Подробнее о соответствии ГОСТ и международных подходов – в статье
Сопоставление ГОСТ и ISO: как унифицировать проектную документацию.
Наша внутренняя структура опирается на ГОСТ 34 (стадии), ГОСТ 19 (состав документов) и ISO/IEEE (безопасность, архитектура, DevOps).
Также выделяем уровни фиксации архитектуры – от идеи до реализации и сопровождения, чтобы адаптировать глубину документации под контекст проекта.
Что это даёт бизнесу
- Управляемость – система не теряется при смене людей; решения и границы зафиксированы.
- Повторяемость – решение воспроизводимо и масштабируемо в новых командах и средах.
- Прозрачность – понятны логика решений, роли, ответственность и критерии качества.
- Готовность к сертификации – сформирован пакет артефактов для аудита по ГОСТ/ISO.
Что дальше
Хотите внедрить или обновить пакет документации по ГОСТ/ISO?
адаптируем состав под ваш проект и ограничения;
передадим шаблоны (ТЗ, ТП, ПМИ, руководства) и чек-листы проверки;
сопроводим внедрение и проведем пилот.
Напишите нам – поможем превратить документацию в опору для развития, а не барьер.
06.05.2025 (обн. 06.11.2025)