Раздел с архитектурными артефактами: C4, UML, последовательности, потоки данных и бизнес-процессы.
Задача этого раздела: быстро объяснить, как устроена система, где проходят границы ответственности и как функциональность работает в реальных сценариях.
Типы артефактов
- Контекстная диаграмма
- Диаграмма компонентов
- Диаграмма последовательности
- BPMN-процесс
- ERD / модель данных
Что документирую в архитектуре
- Границы системы: что внутри продукта, что относится к внешним интеграциям.
- Основные сервисы и их ответственность: frontend, backend, API, хранилища, очереди.
- Ключевые пользовательские и системные сценарии: happy path и ошибки.
- Технические ограничения: зависимости, retry, таймауты, точки отказа.
- Связь диаграмм с документацией API, инструкциями и release notes.
Примеры в портфолио
Какие вопросы закрывает раздел
- Какие компоненты участвуют в реализации фичи?
- Где источник истины по данным?
- Какие сервисы вызываются синхронно, какие асинхронно?
- Что происходит при ошибках и как система восстанавливается?
- Как изменение в одном сервисе повлияет на другие части системы?
Как поддерживаю актуальность
- Обновляю диаграммы в рамках той же задачи, где меняется функциональность.
- Добавляю ссылку на измененные API-контракты и сценарии.
- Фиксирую риски и ограничения в тексте рядом с диаграммой.
- Провожу ревью с разработкой/QA перед релизом.
Definition of Done для архитектурной документации
- Диаграмма отражает текущую реализацию, а не черновую гипотезу.
- Для ключевого сценария есть последовательность шагов и обработка ошибок.
- Указаны внешние зависимости и зона ответственности сервисов.
- Есть ссылки на связанные API-страницы, инструкции и релизные изменения.