Документацию условно можно разделить на техническую (ориентированную на разработчиков и администраторов) и пользовательскую (ориентированную на конечных пользователей, операторов, бизнес-аналитиков). Также можно классифицировать по стадии или назначению:
1. Vision & Scope / Бизнес-требования
- Описывают стратегические цели, бизнес-контекст, почему система нужна и что она должна дать организации.
2. Спецификация требований (SRS)
- Детально фиксирует функциональные и нефункциональные требования, сценарии использования.
- Может включать диаграммы, схемы, прототипы.
3. Техническая спецификация / архитектурное описание
- Архитектурные схемы (C4-модель, UML component, deployment, sequence).
- Описание основных модулей, паттернов, используемых технологий.
- Интеграционные схемы (API, очереди, микросервисы).
4. Пользовательская документация
- Руководства, мануалы, справочная система, инструкции для операторов.
- Часто оформляются в формате wiki, PDF, онлайн-хелпа.
5. Администраторская / эксплуатационная документация
- Описывает, как разворачивать систему, конфигурировать, мониторить, проводить бэкап и обновления.
- Включает схемы инфраструктуры, логику DevOps-пайплайна.
6. Документация по тестам
- Тест-планы, тест-кейсы, чек-листы.
- Отчёты о проведённом тестировании, покрытии, найденных дефектах.
7. История изменений / Release Notes
- Краткое описание, что изменилось в каждом релизе: новые функции, исправленные баги, известные ограничения.
8. Architecture Decision Records (ADR)
- Краткие «протоколы» ключевых архитектурных решений (почему выбрали Kafka, почему отказались от микросервисов и т. д.), чтобы помнить логику выбора.