Ответ
Отчетная документация в IT-проекте обычно включает:
-
Технические документы:
- ТЗ (техническое задание)
- Архитектурные схемы
- API-документация (например, Swagger)
swagger: "2.0"
info:
title: Sample API
version: 1.0.0-
Процессные документы:
- План проекта (Gantt-диаграммы)
- Отчеты о статусе (прогресс, риски, бюджет)
- Митинговые заметки
-
Тестовая документация:
- Test cases
- Отчеты о багах
- Результаты нагрузочного тестирования
-
Операционные документы:
- Руководство пользователя
- Инструкции по развертыванию
- Runbook для поддержки
Ключевой принцип: документы должны быть актуальными, доступными и содержать только необходимую информацию. Часто используется wiki-системы (Confluence, GitBook) или код-как-документация (JSDoc, Swagger).
