Домен
Документация
Профиль навыка
Документация архитектуры: C4 model, arc42, ADR, design documents, RFC
Ролей
7
где встречается этот навык
Грейдов
5
сформированная дорожка роста
Обязательных требований
25
ещё 6 — необязательные
Документация
Техническая документация
17.03.2026
Выберите текущий грейд и сравните ожидания. Карточки ниже покажут, что нужно закрыть для следующего уровня.
Таблица показывает, как меняется глубина владения навыком от Junior до Principal.
| Роль | Обязательность | Описание |
|---|---|---|
| Database Engineer / DBA | Понимает основы подходов к архитектурной документации, таких как модель C4 и arc42. Умеет читать и интерпретировать существующие архитектурные диаграммы и записи решений. Следует установленным шаблонам и руководствам при внесении вклада в документацию архитектуры баз данных. Документирует простые изменения схемы и диаграммы потоков данных под руководством. | |
| Security Analyst | Понимает основы архитектурной документации, включая диаграммы C4 и шаблоны arc42. Умеет читать модели угроз и документы по архитектуре безопасности. Следует руководствам команды при документировании средств защиты и их расположения в архитектуре системы. Создаёт базовые диаграммы компонентов безопасности под руководством. | |
| Technical Product Manager | Обязателен | Понимает значение архитектурной документации для технических решений. Знаком с форматами ADR (Architecture Decision Records) и C4-моделью. Читает архитектурные диаграммы и участвует в обсуждении технических решений. |
| Technical Writer | Обязателен | Понимает основные типы архитектурной документации: system overview, component diagrams, sequence diagrams, deployment diagrams. Знает нотацию C4 model на базовом уровне. Умеет документировать простые архитектурные решения по шаблону. |
| Роль | Обязательность | Описание |
|---|---|---|
| Database Engineer / DBA | Документирует database архитектуру: ER-диаграммы, описание таблиц и связей, data flow diagrams. Ведёт документацию database configurations, backup procedures, connection details для каждого environment. | |
| Engineering Manager | Самостоятельно ведёт архитектурную документацию с использованием фреймворков C4 и arc42 для сервисов команды. Пишет и рецензирует Architecture Decision Records (ADR), фиксирующие ключевые технические решения. Понимает компромиссы между лёгким и всеобъемлющим подходами к документации. Обеспечивает актуальность архитектурных документов команды по мере развития системы. | |
| Security Analyst | Самостоятельно создаёт документацию архитектуры безопасности с использованием диаграмм C4 на уровнях контекста, контейнеров и компонентов. Пишет ADR для решений в области безопасности, таких как потоки аутентификации и стратегии шифрования. Понимает компромиссы между детализацией документации и затратами на её поддержку в контексте безопасности. Документирует границы доверия и классификацию данных в разделах безопасности arc42. | |
| Technical Lead | Самостоятельно применяет модель C4 и arc42 для документирования архитектуры сервисов команды и их интеграций. Составляет ADR, чётко фиксирующие контекст, решение и последствия технических выборов. Понимает компромиссы между инструментами diagram-as-code (Structurizr, PlantUML) и визуальными редакторами. Поддерживает документацию в соответствии с CI/CD-пайплайнами и топологией деплоя. | |
| Technical Product Manager | Обязателен | Самостоятельно инициирует создание ADR для ключевых продуктовых решений с техническим обоснованием. Ревьюит архитектурную документацию на соответствие продуктовым требованиям. Ведёт актуальный реестр технических решений. |
| Technical Writer | Обязателен | Создаёт полноценную архитектурную документацию совместно с архитекторами: system context, container diagrams, component diagrams (C4). Документирует data flows, интеграции со внешними системами, deployment topology. Поддерживает документацию в актуальном состоянии. |
| Роль | Обязательность | Описание |
|---|---|---|
| Database Engineer / DBA | Обязателен | Создаёт comprehensive database документацию: architecture decision records для выбора СУБД, capacity planning documents, disaster recovery plans. Документирует replication topology и failover procedures. |
| Engineering Manager | Обязателен | Проектирует стандарты архитектурной документации для нескольких команд с использованием C4 и arc42 в качестве основных фреймворков. Внедряет рабочие процессы ADR, интегрированные в код-ревью и pull request процессы. Менторит тимлидов по эффективным практикам документирования, балансирующим полноту и продуктивность разработчиков. Продвигает внедрение инструментов diagram-as-code (Structurizr, Mermaid) для версионирования документации вместе с исходным кодом. |
| Security Analyst | Обязателен | Проектирует комплексные фреймворки документации архитектуры безопасности, объединяя модели C4 с результатами моделирования угроз (STRIDE, PASTA). Создаёт детализированные представления безопасности arc42, охватывающие границы доверия, уровни шифрования и требования комплаенса. Менторит команду по документированию решений архитектуры безопасности с надлежащей оценкой рисков в ADR. Оптимизирует процессы документирования для отражения результатов аудитов безопасности в архитектурных артефактах. |
| Solutions Architect | Обязателен | Проектирует сквозную архитектурную документацию на всех четырёх уровнях C4 — от контекста системы до кода. Создаёт комплексную документацию arc42, охватывающую требования к качеству, представления времени выполнения и сценарии деплоя. Менторит инженеров по написанию эффективных ADR, фиксирующих архитектурные драйверы, рассмотренные альтернативы и анализ компромиссов. Масштабирует практики документирования на несколько доменов решений с использованием шаблонов и автоматизированной валидации. |
| Technical Lead | Обязателен | Проектирует стратегию архитектурной документации для сложных мультисервисных систем с использованием C4 и arc42. Устанавливает конвенции ADR, включая нумерацию, состояния жизненного цикла и правила замещения. Менторит разработчиков по созданию содержательных диаграмм компонентов и контейнеров вместо поверхностных обзоров. Интегрирует генерацию документации в CI-пайплайны с использованием Structurizr DSL или аналогичных инструментов diagram-as-code. |
| Technical Product Manager | Обязателен | Формирует процесс архитектурного документирования для продукта, включая RFC и design docs. Определяет шаблоны технических спецификаций с учётом бизнес-контекста. Обеспечивает трассируемость от бизнес-требований к архитектурным решениям. |
| Technical Writer | Обязателен | Проектирует структуру и процесс ведения архитектурной документации для крупных систем. Внедряет diagrams-as-code подход (Mermaid, PlantUML, Structurizr DSL). Обеспечивает связность между ADR, архитектурными диаграммами и API-документацией. |
| Роль | Обязательность | Описание |
|---|---|---|
| Database Engineer / DBA | Обязателен | Определяет стандарты database документации: шаблоны для database architecture docs, runbooks, data dictionaries. Координирует documentation-as-code подход для database artifacts. Проводит documentation reviews. |
| Engineering Manager | Обязателен | Определяет стратегию архитектурной документации на уровне команды и продукта. Устанавливает обязательные стандарты документации C4 и arc42 для всех новых сервисов и крупных рефакторингов. Проводит архитектурные ревью, обеспечивая качество документации на уровнях контекста, контейнеров, компонентов и деплоя. Интегрирует практики ADR в жизненный цикл разработки с чётким распределением ответственности и регулярными ревью между командами. |
| Security Analyst | Обязателен | Определяет стратегию документации архитектуры безопасности на уровне команды и продукта. Устанавливает стандарты документирования границ безопасности, потоков данных и моделей угроз с использованием C4 и arc42. Проводит ревью архитектуры безопасности, обеспечивая корректную фиксацию решений по рискам, обоснований комплаенса и стратегий митигации в ADR. Продвигает практики документации безопасности в командах разработки через шаблоны и чек-листы ревью. |
| Solutions Architect | Обязателен | Определяет стратегию архитектурной документации на уровне продукта и портфолио с использованием C4 и arc42 как канонических фреймворков. Устанавливает управление документацией, включая контрольные точки ревью, политики актуальности и стандарты согласованности между командами. Проводит архитектурные ревью, обеспечивая фиксацию точек интеграции, сценариев атрибутов качества и ограничений деплоя. Продвигает внедрение ADR как основного механизма фиксации и коммуникации архитектурных решений. |
| Technical Lead | Обязателен | Определяет стратегию архитектурной документации на уровне команды и продукта, выбирая подходящую глубину C4 и разделы arc42 в зависимости от критичности сервиса. Устанавливает лучшие практики создания ADR, включая шаблоны, рабочие процессы статусов и привязку к PR реализации. Проводит регулярные ревью архитектурной документации для предотвращения расхождений между диаграммами и реальным состоянием системы. Продвигает культуру documentation-as-code с автоматизированным рендерингом и пайплайнами публикации. |
| Technical Product Manager | Обязателен | Определяет стандарты архитектурной документации для подразделения. Внедряет culture of writing — design docs, RFCs, post-mortems как обязательные артефакты. Интегрирует архитектурные решения в product roadmap. |
| Technical Writer | Обязателен | Определяет стандарты архитектурной документации для организации: обязательные артефакты, уровни детализации, процесс review. Координирует архитектурную документацию между командами, обеспечивая единую картину системного ландшафта. |
| Роль | Обязательность | Описание |
|---|---|---|
| Database Engineer / DBA | Обязателен | Формирует documentation стратегию для data-платформы: automated data catalog (DataHub, Apache Atlas), living documentation для database architecture, compliance documentation. Определяет knowledge management для database engineering. |
| Engineering Manager | Обязателен | Определяет стратегию архитектурной документации на уровне организации. Устанавливает корпоративные стандарты C4 и arc42, обеспечивая согласованность по всем подразделениям и продуктовым линейкам. Создаёт фреймворки управления жизненным циклом ADR, включая межкомандное обнаружение, политики устаревания и функции архитектурной пригодности. Менторит лидов и архитекторов по построению культуры документирования, масштабируемой вместе с ростом организации. |
| Security Analyst | Обязателен | Определяет стратегию документации архитектуры безопасности на уровне организации. Устанавливает корпоративные стандарты документирования архитектур безопасности с использованием C4 и arc42, согласованные с фреймворками комплаенса (SOC 2, ISO 27001, NIST). Создаёт межорганизационное управление ADR для решений безопасности, обеспечивая прослеживаемость от моделей угроз до реализованных средств защиты. Менторит лидов и архитекторов по интеграции документации безопасности в общий жизненный цикл архитектурной документации. |
| Solutions Architect | Обязателен | Определяет стратегию архитектурной документации на уровне организации, устанавливая корпоративные стандарты C4 и arc42 для всех доменов решений. Создаёт федеративную модель управления документацией, обеспечивающую автономию команд при сохранении архитектурной согласованности на уровне предприятия. Формирует репозитории ADR со сквозным поиском, анализом влияния и управлением архитектурными знаниями. Менторит лидов и архитекторов по развитию практик документирования для поддержки масштабирования организации, интеграции при M&A и согласования с technology radar. |
| Technical Lead | Обязателен | Определяет стратегию архитектурной документации на уровне организации, стандартизируя использование C4 и arc42 по всем инженерным подразделениям. Устанавливает корпоративное управление ADR с централизованными реестрами, межсменным связыванием и автоматическим обнаружением устаревания. Продвигает внедрение инструментальных цепочек архитектурной документации (Structurizr, Backstage, функции архитектурной пригодности) в масштабе. Менторит лидов и архитекторов по построению самоподдерживающихся экосистем документации, сохраняющих точность по мере развития организации. |
| Technical Product Manager | Обязателен | Формирует enterprise-подход к управлению архитектурными знаниями. Определяет governance-процесс для cross-team архитектурных решений, строит базу знаний по техническим trade-offs на уровне организации. |
| Technical Writer | Обязателен | Формирует стратегию архитектурных знаний компании: единый architecture knowledge base, связь с enterprise architecture, governance процессы. Определяет как архитектурная документация поддерживает принятие стратегических технических решений. |