Что должна содержать документация
Основные вопросы
- зачем писать
- что писать
- Докумет маршрута
-
Артефакты проектных процессов
- флоу разработки
- статусная модкль задач
- доски с беклогом
- план-график
- список контактов
- Глоссарий
-
Артефакты без процесса
- что в итоге должно быть
-
Концептульная модель системы
- описывает верхнеуровневую фцункциональность и заимодействие с другими системами ( BPNMN)
-
Классы пользователей и уровни доступов
- все что собирается при разработке требований
- Сценарии использования
-
Логика работы системы
- модель данных
- описание процессов реализации
- Описание апи
-
Тестовые данные
- среды
- учетные данные
-
Ограничения/нефункцинльаные требования
- Вы договорились, что рассчитываете максимум на 100 пользователей? Делаете импорт справочников раз в сутки в час ночи?
-
Архитектура системы
- логическая модель
- требования к составу и формату данных
- характеристики БД
- Макеты
-
Описание интегарций
- протоколы
- спецификации
- процессы
- потоки
- Безопасность
- Внешняя документция
P.S Больше схем и диаграмм
Исходный док: https://habr.com/ru/articles/549588/