Профиль навыка

Документация как код

Markdown, AsciiDoc, пайплайны документации, ревью процесс, генерация сайтов

Контроль версий и коллаборация Инструменты совместной работы

Ролей

18

где встречается этот навык

Грейдов

5

сформированная дорожка роста

Обязательных требований

35

ещё 51 — необязательные

Домен

Контроль версий и коллаборация

Группа

Инструменты совместной работы

Последнее обновление

17.03.2026

Как использовать

Выберите текущий грейд и сравните ожидания. Карточки ниже покажут, что нужно закрыть для следующего уровня.

Чего ждут на каждом уровне

Таблица показывает, как меняется глубина владения навыком от Junior до Principal.

Роль Обязательность Описание
Analytics Engineer Документирует dbt-модели в YAML: описания моделей и колонок, tags для категоризации. Следует шаблонам команды для doc blocks. Поддерживает README с описанием структуры dbt-проекта и инструкциями для новых членов команды.
Backend Developer (C#/.NET) Пишет документацию для C#: XML doc comments, README files. Генерирует docs через DocFX.
Backend Developer (Go) Пишет Go documentation: godoc comments, README files, code examples. Понимает godoc conventions.
Backend Developer (Java/Kotlin) Пишет Java documentation: Javadoc comments, README files. Генерирует docs через Maven javadoc plugin.
Backend Developer (Node.js) Пишет документацию в коде: JSDoc/TSDoc комментарии, README files, API examples. Генерирует docs через TypeDoc.
Backend Developer (Python) Пишет Python documentation: docstrings (Google/NumPy style), README files. Генерирует docs через Sphinx.
Backend Developer (Rust) Пишет документацию в коде: Rust doc comments (///), README.md, examples в doc tests. Понимает cargo doc generation.
Cloud Engineer Понимает принципы docs-as-code: Markdown/AsciiDoc, документация с контролем версий рядом с инфраструктурным кодом. Умеет писать runbook-и и операционные процедуры в Git-репозиториях. Следует командным конвенциям для README-файлов и архитектурных решений (ADR).
DevOps Engineer Понимает принцип documentation as code: документация в Git рядом с кодом. Пишет README для инфраструктурных репозиториев, создаёт простые runbooks в Markdown. Знает основы Markdown, использует шаблоны для документирования.
Infrastructure Engineer Документирует инфраструктурные компоненты в формате docs-as-code: README.md для Terraform-модулей с описанием input/output, базовые runbook-и в Markdown для типовых операций. Использует terraform-docs для автогенерации документации модулей и ведёт записи об infrastructure decisions.
Language Tooling Engineer Понимает принципы docs-as-code для проектов языкового тулинга: документация грамматик, спецификации поведения парсера и API-референсы в форматах с контролем версий. Пишет документацию одновременно с изменениями кода компилятора/LSP. Следует командным стандартам технической документации.
QA Engineer (Manual) Понимает принципы docs-as-code для тестовой документации: тест-планы, тест-кейсы и чеклисты в Markdown/Git. Ведёт тестовую документацию рядом с исходным кодом в системе контроля версий. Следует командным конвенциям по организации и обновлению QA-документации.
QA Security Engineer Документирует security findings: vulnerability reports, test results, security checklists в Markdown. Следует documentation templates.
Release Engineer Знает базовые концепции documentation as code для release engineer и умеет применять их в типовых задачах. Использует стандартные инструменты и следует установленным практикам команды. Понимает когда и почему применяется данный подход.
Technical Writer Обязателен Понимает принцип documentation-as-code: документация хранится в Git, версионируется вместе с кодом, проходит review через pull requests. Умеет создавать и редактировать Markdown-файлы в репозитории, отправлять PR с изменениями документации.
Роль Обязательность Описание
Analytics Engineer Создаёт комплексную документацию dbt-проекта: doc blocks для reusable описаний, markdown файлы для бизнес-контекста, ERD-диаграммы для data models. Настраивает dbt docs generate и deploy для автоматической публикации документации.
Backend Developer (C#/.NET) Реализует docs-as-code: DocFX для API docs, Swagger/OpenAPI generation, code examples.
Backend Developer (Go) Реализует docs-as-code: comprehensive godoc, OpenAPI generation, example tests as documentation.
Backend Developer (Java/Kotlin) Реализует docs-as-code: comprehensive Javadoc, Spring REST Docs, AsciiDoc для guides.
Backend Developer (Node.js) Реализует docs-as-code: OpenAPI generation из NestJS, TypeDoc для libraries, Docusaurus для guides. Интегрирует в CI.
Backend Developer (Python) Реализует docs-as-code: Sphinx/MkDocs, OpenAPI generation, code examples as tests.
Backend Developer (Rust) Реализует docs-as-code: comprehensive rustdoc, mdBook для guides, automated API docs generation. Интегрирует documentation в CI.
Cloud Engineer Документирует облачную инфраструктуру как код: terraform-docs для автоматической генерации README модулей, Architecture Decision Records (ADR) для ключевых решений. Поддерживает diagrams-as-code через Mermaid/PlantUML для сетевых топологий и архитектурных схем.
DevOps Engineer Внедряет documentation as code: автогенерация docs из Terraform (terraform-docs), Helm (helm-docs), OpenAPI. Настраивает MkDocs/Docusaurus для внутренней документации, CI/CD для автопубликации. Создаёт architecture decision records (ADR).
Engineering Manager Внедряет docs-as-code практики в команде: ревью документации как часть PR-процесса, автоматические сборки документации и интеграция с CI/CD. Понимает компромиссы между wiki-based и Git-based документацией. Обеспечивает фиксацию архитектурных решений как ADR.
Infrastructure Engineer Создаёт комплексную документацию инфраструктуры как код: ADR (Architecture Decision Records) для инфраструктурных решений, runbook-и с автоматической валидацией через CI. Генерирует network diagrams из Terraform через inframap, поддерживает inventory документацию и настраивает автоматическую публикацию через MkDocs.
Language Tooling Engineer Реализует docs-as-code для языкового тулинга: автогенерация API-документации из кода, интерактивная документация playground грамматик и версионированная спецификация языка. Использует генераторы документации (TypeDoc, rustdoc, godoc) как часть билд-пайплайна. Поддерживает автоматизацию changelog из истории коммитов.
QA Engineer (Manual) Реализует docs-as-code воркфлоу для QA: автогенерация тестовой документации из инструментов управления тестами, живые тест-планы, обновляемые с каждым релизом, и матрицы трассировки в системе контроля версий. Использует генераторы статических сайтов для порталов тестовой документации. Автоматизирует отчёты покрытия тестами как артефакты документации.
QA Security Engineer Создаёт security documentation: test plans, security assessment reports, runbooks в git-managed docs. Автоматизирует report generation.
Release Engineer Уверенно применяет documentation as code для release engineer при решении нестандартных задач. Самостоятельно выбирает оптимальный подход и инструменты. Анализирует trade-offs и предлагает улучшения существующих решений.
Technical Lead Внедряет docs-as-code в воркфлоу разработки: требования к документации в чеклистах PR, автоматическая генерация API-референсов (OpenAPI, GraphQL schema) и руководства разработчика рядом с кодом. Устанавливает стандарты документации для команды и обеспечивает консистентность.
Technical Writer Обязателен Полноценно работает по docs-as-code workflow: branch → write → PR → review → merge → deploy. Настраивает CI/CD для автоматической сборки и публикации документации. Использует linting (markdownlint, vale) для контроля качества текста.
Роль Обязательность Описание
Analytics Engineer Обязателен Проектирует систему документирования аналитической платформы: integration dbt docs с data catalog, automated freshness и lineage documentation, glossary бизнес-терминов. Внедряет documentation-as-code с CI-валидацией полноты описаний.
Backend Developer (C#/.NET) Проектирует documentation strategy: living documentation, automated API docs, versioned guides.
Backend Developer (Go) Проектирует стратегию документации для Go-сервисов: API-документация через godoc, автоматическая генерация README из комментариев кода, версионированные архитектурные руководства. Реализует тестирование документации (example tests как living docs). Создаёт runbook-и и операционную документацию рядом с кодом сервисов. Интегрирует сборки документации в CI/CD пайплайн.
Backend Developer (Java/Kotlin) Проектирует documentation strategy: living docs, Spring REST Docs automation, versioned API docs.
Backend Developer (Node.js) Проектирует documentation strategy: automated API docs, living documentation, versioned guides. Внедряет docs-as-code pipeline.
Backend Developer (Python) Проектирует стратегию документации для Python-сервисов: API-документация через Sphinx/MkDocs с autodoc, референсы интерфейсов с type annotations и версионированные руководства по миграции. Реализует верификацию документации через doctest. Создаёт комплексную документацию онбординга разработчиков и операционные runbook-и рядом с кодом сервисов.
Backend Developer (Rust) Проектирует documentation strategy: living documentation, automated architecture diagrams, versioned docs. Внедряет docs-as-code pipeline.
Cloud Engineer Обязателен Проектирует documentation-as-code для облачной платформы: автогенерация архитектурных диаграмм из Terraform state, self-documenting modules с examples, automated docs pipeline в CI. Внедряет Backstage/internal developer portal с актуальной документацией по инфраструктуре.
DevOps Engineer Обязателен Проектирует систему документации для DevOps: единый портал (Backstage) с автогенерированной документацией, runbooks с интеграцией мониторинга. Внедряет docs-as-code pipeline: автоматическая валидация, link checking, freshness alerts.
Engineering Manager Обязателен Проектирует архитектуру документации для инженерных команд: порталы разработчика (Backstage, Docusaurus), автоматизированные пайплайны документации и метрики качества документации. Обеспечивает соответствие покрытия документации доставке фич. Устанавливает процессы ревью документации и модели ownership. Менторит команду по эффективному техническому письму.
Infrastructure Engineer Обязателен Проектирует систему документации инфраструктуры: автогенерация из IaC-кода (terraform-docs, ansible-doc), живые architecture diagrams через Mermaid/D2, интеграция с service catalog. Внедряет documentation testing (broken links, schema validation), создаёт шаблоны для postmortem-ов и проектирует knowledge base для on-call инженеров.
Language Tooling Engineer Обязателен Проектирует комплексные системы документации для языковых инструментов: интерактивная документация с встроенным выполнением кода, version-aware API-референсы и руководства по миграции, генерируемые из детекции breaking changes. Реализует тестирование документации (doctests) как часть CI. Менторит команду по архитектуре документации.
QA Engineer (Manual) Обязателен Проектирует системы документации для QA-процессов: живые дашборды качества, автоматическая генерация свидетельств тестирования и compliance-документация как код. Реализует двунаправленную трассировку между требованиями, тест-кейсами и дефектами в системе контроля версий. Менторит команду по эффективным практикам QA-документации.
QA Security Engineer Обязателен Проектирует security documentation framework: threat model docs, security architecture docs, automated evidence collection для compliance. Версионирует security policies.
Release Engineer Экспертно применяет documentation as code для release engineer для проектирования сложных систем. Оптимизирует существующие решения и предотвращает архитектурные ошибки. Проводит code review и обучает коллег лучшим практикам.
Solutions Architect Обязателен Проектирует enterprise-архитектуру документации: мульти-проектные сайты документации, системы перекрёстных ссылок и фреймворки архитектурной документации (C4, arc42). Реализует пайплайны документации, агрегирующие контент из множества репозиториев. Создаёт стандарты governance документации для клиентских технических поставок.
Technical Lead Обязателен Проектирует стратегию документации для продукта: living documentation, автоматические API-документы из аннотаций кода (Swagger, TypeDoc), версионированные руководства, синхронизированные с циклами релизов. Внедряет quality gates документации в CI/CD. Создаёт стандарты архитектурной документации (ADR, C4 диаграммы) и обеспечивает их принятие командой.
Technical Writer Обязателен Проектирует масштабируемые docs-as-code процессы: multi-repo documentation, cross-references, automated content generation. Внедряет content reuse (snippets, includes, variables). Создаёт custom CI checks для quality gates документации.
Роль Обязательность Описание
Analytics Engineer Обязателен Определяет стандарты документирования для аналитической организации: обязательные описания для всех production-моделей, шаблоны для новых моделей и packages. Внедряет metrics и SLA для documentation coverage, автоматические reminders для undocumented моделей.
Backend Developer (C#/.NET) Определяет documentation стандарты: mandatory XML docs, review process, quality gates.
Backend Developer (Go) Определяет documentation стандарты: mandatory godoc, review process, quality gates.
Backend Developer (Java/Kotlin) Определяет documentation стандарты: mandatory Javadoc, API doc requirements, review process.
Backend Developer (Node.js) Определяет documentation стандарты: mandatory TSDoc, API doc requirements, review process. Внедряет documentation quality gates.
Backend Developer (Python) Определяет documentation стандарты: mandatory docstrings, review process, quality gates.
Backend Developer (Rust) Определяет documentation стандарты: mandatory doc comments, review process, freshness metrics. Внедряет documentation quality gates.
Cloud Engineer Обязателен Определяет стандарты документирования инфраструктуры: template для ADR, runbook structure, service catalog format. Внедряет docs-as-code workflow — PR-based updates, automated freshness checks, documentation coverage metrics. Обучает команды культуре документирования.
DevOps Engineer Обязателен Определяет стандарты документирования для организации: обязательная документация для каждого сервиса, шаблоны ADR и runbooks, процессы review. Проектирует Internal Developer Portal с каталогом сервисов, автоматической документацией и search.
Engineering Manager Обязателен Определяет стратегию documentation-as-code для инженерной организации. Устанавливает стандарты документации, процессы ревью и метрики качества между командами. Продвигает внедрение портала разработчика для централизованного обнаружения документации. Обеспечивает соответствие практик документации требованиям compliance и аудита.
Infrastructure Engineer Обязателен Определяет стандарты документации инфраструктуры для организации: обязательные разделы для каждого Terraform-модуля, шаблоны runbook-ов и playbook-ов, стандарты ADR. Внедряет docs-as-code pipeline с review-процессом, ревьюит документацию команд на полноту и координирует создание on-call handbook.
Language Tooling Engineer Обязателен Определяет стратегию документации для платформы языкового тулинга: унифицированный портал документации, мульти-версионный хостинг документации и стандарты документации для контрибьюторов. Устанавливает процессы ревью документации и quality gates. Создаёт гайдлайны по интерактивным примерам и интеграции playground в документацию.
QA Engineer (Manual) Обязателен Определяет стратегию Документация как код на уровне команды/продукта. Формирует стандарты и best practices. Проводит review.
QA Security Engineer Обязателен Определяет security documentation стандарты: required documents per project, templates, review process. Внедряет docs-as-code для security policies и procedures.
Release Engineer Устанавливает стандарты применения documentation as code для release engineer в команде и принимает архитектурные решения. Определяет технический roadmap с учётом данного навыка. Менторит senior инженеров и влияет на практики смежных команд.
Solutions Architect Обязателен Определяет стратегию документации для архитектурной практики. Устанавливает стандарты для архитектурных поставок, документации решений и клиентского технического контента. Создаёт шаблоны и фреймворки документации для повторяемых проектов. Продвигает внедрение documentation-as-code в клиентских проектах.
Technical Lead Обязателен Определяет стратегию documentation-as-code на уровне продукта/департамента. Устанавливает стандарты API-документации, архитектурных решений и руководств разработчика. Продвигает внедрение портала разработчика (Backstage, Docusaurus) для централизованной документации. Создаёт governance для ownership и поддержки документации.
Technical Writer Обязателен Определяет организационный стандарт docs-as-code: workflows, branching strategy для docs, review процессы, quality metrics. Координирует миграцию команд на docs-as-code подход. Создаёт contribution guidelines для разработчиков.
Роль Обязательность Описание
Analytics Engineer Обязателен Проектирует enterprise data documentation платформу: единый портал с dbt docs, BI glossary и data contracts. Определяет стратегию data literacy: onboarding для новых аналитиков, self-service data discovery, automated documentation через AI.
Backend Developer (C#/.NET) Формирует documentation стратегию: platform-wide docs-as-code, developer portal, governance.
Backend Developer (Go) Формирует стратегию документации для Go-платформенной организации: стандарты docs-as-code, архитектура портала разработчика и governance документации между командами. Продвигает документацию как ключевую инженерную практику с измеримыми метриками качества. Устанавливает стандарты open-source документации для публичных Go-библиотек и сервисов.
Backend Developer (Java/Kotlin) Формирует стратегию документации для Java-платформенной организации: стандарты Javadoc, портал разработчика с автоматической агрегацией API-референсов и governance документации. Продвигает документацию как конкурентное преимущество для adoption внутренней платформы. Устанавливает качество документации как инженерный KPI между Java-командами.
Backend Developer (Node.js) Формирует documentation стратегию: platform-wide docs-as-code, automated generation, developer portal. Определяет documentation governance.
Backend Developer (Python) Формирует стратегию документации для Python-платформенной организации: инфраструктура Sphinx/MkDocs, автоматические сборки документации из type hints и docstrings и governance портала разработчика. Продвигает документацию как ключевую инженерную практику между Python-командами. Устанавливает стандарты open-source документации для публичных Python-пакетов.
Backend Developer (Rust) Формирует documentation стратегию: platform-wide docs-as-code, automated generation, developer experience. Определяет documentation governance.
Cloud Engineer Обязателен Формирует documentation strategy на enterprise-уровне: unified service catalog, automated architecture documentation from IaC, knowledge base для operational procedures. Проектирует internal developer platform с self-service docs, API reference и interactive architecture explorer.
DevOps Engineer Обязателен Разрабатывает стратегию knowledge management для инженерной организации: Internal Developer Portal (Backstage/Port), automated documentation, living docs. Определяет архитектуру платформы знаний: от автогенерации до AI-powered search и рекомендаций.
Engineering Manager Обязателен Определяет enterprise-стратегию документации: platform docs-as-code, стандарты developer experience и governance документации для всей организации. Продвигает культурный сдвиг к отношению к документации как к first-class инженерному артефакту. Оценивает и выбирает инвестиции в платформы документации.
Infrastructure Engineer Обязателен Формирует стратегию knowledge management для инфраструктуры компании: архитектура Internal Developer Portal с автогенерированной документацией, integration Backstage с IaC-репозиториями. Определяет стандарты technical writing для infrastructure, roadmap для AI-assisted documentation и метрики documentation coverage для compliance.
Language Tooling Engineer Обязателен Определяет организационную стратегию документации для экосистемы языкового тулинга: унифицированные стандарты документации, мульти-языковая инфраструктура документации и практики open-source документации. Продвигает документацию как конкурентное преимущество для adoption инструментов разработки. Формирует индустриальные стандарты документации языков.
QA Engineer (Manual) Обязателен Определяет enterprise-стратегию QA-документации: стандартизированная отчётность качества, автоматизация compliance-документации и управление свидетельствами тестирования как код. Продвигает внедрение практик living documentation в QA-командах. Формирует организационную культуру documentation-driven обеспечения качества.
QA Security Engineer Обязателен Проектирует security knowledge management: organizational security wiki, automated policy distribution, compliance evidence management. Определяет documentation governance.
Release Engineer Формирует стратегию применения documentation as code для release engineer на уровне организации. Определяет best practices и влияет на выбор технологий за пределами своей команды. Является признанным экспертом в данной области.
Solutions Architect Обязателен Определяет enterprise-стратегию документации для всех архитектурных практик. Устанавливает документацию как ключевой deliverable в governance архитектуры. Продвигает стандартизацию фреймворков архитектурной документации (TOGAF, C4) для всей организации. Влияет на индустриальные практики через публикуемые референсные архитектуры и стандарты документации.
Technical Lead Обязателен Определяет enterprise-стратегию documentation-as-code: инфраструктура документации на уровне платформы, governance портала разработчика и качество документации как инженерный KPI. Формирует организационную культуру вокруг документации как конкурентного преимущества. Продвигает кросс-командную стандартизацию документации и управление знаниями.
Technical Writer Обязателен Формирует стратегию documentation-as-code на корпоративном уровне. Определяет как docs-as-code интегрируется с SDLC, developer experience и knowledge management. Обеспечивает масштабируемость подхода при росте организации.

Сообщество

👁 Следить ✏️ Предложить изменение Войдите, чтобы предлагать изменения
📋 Предложения
Пока нет предложений для Документация как код
Загрузка комментариев...