База знаний проекта
Цель
Сделать знания о продукте доступными для команды без устных пересказов и потери контекста.
Что входит в базу знаний
- Архитектура: контекст системы, сервисы, зависимости.
- API и контракты: endpoint’ы, ошибки, ограничения.
- Пользовательские сценарии: happy path и edge cases.
- Инциденты: runbook, troubleshooting, postmortem.
- Релизы: release notes и изменения по версиям.
Структура
- Product Overview
- Architecture
- API
- Integrations
- User Flows
- Operations (runbooks)
- Release Notes
- FAQ
Процесс актуализации
- Любое изменение функциональности должно иметь doc-обновление в том же цикле.
- Изменения в документации проходят review вместе с задачей разработки.
- Для критичных разделов назначены владельцы (owner + backup).
- Раз в спринт проводится ревизия устаревших страниц.
Definition of Done для документации
Изменение считается завершенным, если:
- обновлены API/сценарии/инструкции, которых касается фича;
- добавлены новые ошибки и способы диагностики;
- release notes отражают пользовательские и технические изменения;
- ссылки и диаграммы валидны.
Метрики качества базы знаний
- % задач релиза с обновленной документацией.
- Время поиска ответа support/QA (до/после).
- Количество повторяющихся вопросов по уже описанным сценариям.
- Количество устаревших страниц в ревизии спринта.