Roadmap (6 недель) Неделя Тема Артефакт недели 1 C4 (Context + Container) architecture-overview + 2 диаграммы 2 BPMN процесс отклика на вакансию 3 UML Sequence happy path + error path 4 API docs 3-5 endpoint’ов + ошибки 5 Data + Kafka ERD + event card 6 Runbook + Diataxis runbook + release note + упаковка Система баллов (100) Точность и корректность: 30 Полнота сценариев и ошибок: 25 Структура документации: 20 Ясность языка: 15 Поддерживаемость: 10
Портфолио
Выберите направление
Exams
Exams Midterm (после Week 3) Теория: 10 вопросов Практика: 1 sequence + 1 C4 Final (после Week 6) Теория: 20 вопросов Практика: C4 + BPMN + API + Event + Runbook
Progress Log
Progress Log Неделя Что сделано Балл Комментарий 1 2 3 4 5 6
Quizzes
Quizzes Каждую неделю 5-10 вопросов по теме недели. Минимум 80% правильных для перехода. Раз в 2 недели Смешанный квиз по пройденному материалу.
Week 1: C4
Week 1: C4 (Context + Container) Конспект C4 нужен, чтобы показать систему сверху вниз: кто взаимодействует с продуктом, какие контейнеры участвуют и где границы ответственности. Практика Обязательное: C4 Context + C4 Container для кейса “Отклик на вакансию”. Optional: добавить 5 открытых вопросов к архитектору. Чеклист Понятно, кто внешние акторы. Понятно, где frontend/backend/database. Понятно, какие внешние интеграции. Есть легенда/глоссарий терминов. Мини-квиз (5) Чем Context отличается от Container? Какие границы системы обязательно показывать? Что не стоит добавлять в Context-диаграмму? Как связать C4 с API-документацией? Какие ошибки при построении C4 самые частые? Артефакт недели Ссылка на файл: ... ...
Week 2: BPMN
Week 2: BPMN Конспект BPMN показывает бизнес-процесс: роли, этапы, развилки, исключения. Это не техническая последовательность вызовов. Практика Обязательное: BPMN “Отклик -> Скрининг -> Решение”. Optional: добавить SLA-метки на ключевые этапы. Чеклист Определены роли. Есть точки принятия решения. Есть путь отклонения/ошибки. Процесс понятен без разработчика. Мини-квиз (5) Чем BPMN отличается от Sequence? Какие роли обязательны в этом процессе? Где показать ручной шаг рекрутера? Как обозначить исключение? Что считать завершением процесса? Артефакт недели Ссылка на файл: ... ...
Week 3: Sequence
Week 3: Sequence Практика Обязательное: Sequence для “Отклика” (happy path). Обязательное: Sequence для ошибки (duplicate, timeout или validation). Мини-квиз Чем sync и async вызовы отличаются в диаграмме? Где отмечать retries? Что такое критичный путь сценария? Какие ошибки нужно показывать в sequence? Когда sequence не нужен?
Week 4: API
Week 4: API Практика Обязательное: описать POST /applications, GET /applications/{id}, GET /vacancies. Обязательное: добавить ошибки 400/404/409/422 и что делать клиенту. Мини-квиз Что обязательно в API reference? Чем 409 отличается от 422? Где описывать rate limit? Какие примеры нужны в response? Что такое idempotency и где его фиксировать?
Week 5: Data + Kafka
Week 5: Data + Kafka Практика Обязательное: ERD для candidate/vacancy/application/resume. Обязательное: карточка события application.created. Мини-квиз Что должно быть в event contract? Зачем нужен DLQ? Что такое source of truth? Как связать API поле с БД? Что проверить при дублях событий?
Week 6: Runbook + Diataxis
Week 6: Runbook + Diataxis Практика Обязательное: Runbook для инцидента “не уходят уведомления”. Обязательное: 1 release note с user+tech блоком. Обязательное: разложить материалы по Diataxis. Мини-квиз Чем How-to отличается от Reference? Что обязательно в runbook? Какие метрики указывать в troubleshooting? Что входит в релизный блок для поддержки? Когда документация считается готовой?