Эти навыки не влияют на основной грейд, но покажут полноту вашего профиля.
AI в рабочих процессах
▼
Знает о возможностях AI-инструментов для генерации документации (ChatGPT, Claude, GitHub Copilot). Понимает ограничения AI-генерации: галлюцинации, устаревшие данные, потеря контекста. Использует AI для создания черновиков простых описаний.
Эффективно применяет AI для ускорения документирования: генерация boilerplate, парафраз технических описаний, создание примеров кода. Разрабатывает промпты, адаптированные под стиль и tone of voice документации проекта. Всегда верифицирует AI-output.
Выстраивает workflow интеграции AI в процесс документирования: автогенерация из кода, review-пайплайн, human-in-the-loop валидация. Определяет границы применимости AI и случаи, когда ручное написание предпочтительнее. Обучает команду безопасному использованию AI.
Определяет AI-стратегию для документационной команды: какие задачи автоматизировать, какие оставить ручными. Внедряет custom fine-tuned модели или RAG-подходы для генерации документации со знанием кодовой базы проекта. Формирует метрики качества AI-документации.
AI-ассистенты кодирования
▼
Знает возможности ChatGPT и Claude для задач технического письма: генерация черновиков, рерайт, перевод, создание примеров кода. Понимает ограничения LLM: возможные неточности, устаревание знаний, необходимость верификации.
Эффективно использует ChatGPT и Claude в повседневной работе: создание boilerplate-документации, генерация code samples, переформулирование сложных технических концепций. Создаёт системные промпты под задачи документирования.
Интегрирует LLM в documentation workflow: автогенерация из комментариев кода, review drafts, проверка consistency. Определяет best practices использования AI для команды: когда использовать, что верифицировать, какие задачи не делегировать AI.
Формирует политику использования AI-ассистентов в документационной команде. Оценивает ROI различных LLM-инструментов. Внедряет custom solutions на базе API ChatGPT/Claude для специфических задач документирования.
Знает возможности GitHub Copilot для создания документации: автодополнение Markdown, генерация code samples, создание комментариев в коде. Понимает ограничения и необходимость верификации предложений Copilot.
Эффективно использует Copilot в повседневной работе: генерация Markdown-шаблонов, автодополнение технических описаний, создание code examples. Настраивает Copilot context через файлы-шаблоны для consistency стиля документации.
Интегрирует Copilot в documentation workflow: использует Copilot Chat для анализа кода и генерации описаний, создаёт custom instructions. Определяет best practices использования Copilot для документационной команды.
Определяет стратегию использования AI-assisted writing tools в документационной команде. Оценивает productivity gains, управляет лицензиями. Формирует guidelines по ответственному использованию AI-инструментов.
CI/CD
▼
Понимает назначение CI/CD для документации: автоматическая сборка, валидация, деплой. Знает базовую структуру GitHub Actions workflow. Умеет запускать существующие docs pipelines и интерпретировать результаты.
Настраивает GitHub Actions для documentation pipeline: build, lint, link-check, deploy. Конфигурирует workflows для preview окружений на PR. Использует actions для автогенерации документации (API docs, changelogs).
Проектирует сложные CI/CD pipelines для документации: matrix builds для multi-version docs, conditional deploys, automated testing. Создаёт reusable workflows для нескольких документационных проектов. Оптимизирует build performance.
Определяет CI/CD стратегию для всех документационных проектов организации. Стандартизирует pipelines, управляет shared runners и secrets. Внедряет advanced сценарии: scheduled builds, cross-repo triggers, automated content validation.
Code Review
▼
Понимает базовые принципы code review и может оценивать читаемость кода в документируемых проектах. Знает основные критерии качества кода, помогающие создавать точные описания API и интерфейсов. Способен выявлять несоответствия между кодом и существующей документацией.
Участвует в code review для верификации технической документации на соответствие реальному коду. Оценивает качество комментариев и docstrings в коде, предлагая улучшения для автогенерации документации. Проверяет примеры кода в документации на корректность и актуальность.
Разрабатывает стандарты документирования кода в рамках code review процесса: inline-комментарии, docstrings, README. Проводит review документационных PR на соответствие стилю и полноте покрытия API. Создаёт чеклисты для ревьюеров по проверке документационных аспектов кода.
Определяет политику documentation-as-code review для всего проекта и интегрирует проверки в CI. Стандартизирует подходы к ревью документации в команде: шаблоны, критерии качества, автоматические проверки. Координирует взаимодействие между разработчиками и техническими писателями в review-процессе.
Git и workflow
▼
Понимает базовые продвинутые возможности Git для технического писательства: ветвление для версий документации, синхронизированных с релизами продукта, cherry-pick для переноса исправлений документации между ветками версий, разрешение конфликтов при совместном редактировании. Следует командным конвенциям структуры репозитория docs-as-code.
Уверенно использует Git для docs-as-code workflow: rebase, cherry-pick, squash, stash. Работает с monorepo и multi-repo setups. Настраивает Git hooks для автоматической проверки документации (pre-commit linting).
Проектирует Git-workflow для документационной команды: branching strategy, release docs versioning, automated changelog generation. Работает с Git submodules/subtrees для multi-repo docs. Оптимизирует производительность Git для больших документационных репозиториев.
Определяет Git-стандарты для всех документационных проектов организации. Автоматизирует процессы через Git-based workflows: auto-publish, versioned releases, content approval. Обучает авторов эффективной работе с Git.
Понимает проблему хранения больших бинарных файлов в Git и назначение Git LFS. Знает какие файлы документации требуют LFS: изображения, диаграммы, видео, PDF. Умеет настроить Git LFS для документационного репозитория.
Эффективно использует Git LFS в docs-as-code workflow: отслеживает бинарные файлы, управляет storage quota, оптимизирует clone/fetch для CI. Документирует процесс работы с LFS для команды. Решает типичные проблемы (missing files, bandwidth limits).
Проектирует стратегию хранения медиа-контента документации: выбор между Git LFS, CDN, object storage. Оптимизирует pipeline для работы с большими документационными репозиториями. Настраивает LFS-compatible CI/CD для автоматической публикации.
Определяет организационные стандарты работы с бинарным контентом в документации. Управляет LFS server и storage. Оптимизирует стоимость хранения и transfer bandwidth для документационных проектов.
GraphQL
▼
Понимает основы проектирования GraphQL-схем для написания точной API-документации. Читает и интерпретирует определения типов, запросы и мутации GraphQL для целей документирования. Следует принятым в команде соглашениям по документированию GraphQL-эндпоинтов с использованием инструментов GraphQL Playground и аннотаций схемы.
Создаёт полноценную GraphQL API-документацию: schema reference, query examples, mutation guides, error handling. Использует GraphQL introspection для автогенерации reference docs. Документирует best practices использования API.
Документирует сложные GraphQL-паттерны: federation, schema stitching, custom directives, real-time subscriptions. Создаёт interactive GraphQL explorer для developer portal. Разрабатывает migration guides при эволюции schema.
Определяет стандарты документирования GraphQL API для организации. Создаёт шаблоны и guidelines. Обеспечивает consistency документации при работе нескольких команд над federated GraphQL schema.
gRPC
▼
Понимает основы gRPC и Protocol Buffers для написания точной API-документации. Читает определения proto-файлов и описания сервисов для целей документирования. Следует принятым в команде соглашениям по документированию эндпоинтов gRPC-сервисов, типов сообщений и паттернов стриминга.
Создаёт документацию для gRPC API: service reference, message schemas, streaming patterns, error codes. Настраивает автогенерацию документации из .proto файлов (protoc-gen-doc, buf). Документирует proto style guide.
Документирует сложные gRPC-паттерны: bidirectional streaming, interceptors, load balancing, deadlines. Создаёт architecture docs для gRPC-based microservices. Разрабатывает migration guides при обновлении proto-контрактов.
Определяет стандарты документирования gRPC/Protobuf для организации. Внедряет автоматизированные pipelines для proto docs. Обеспечивает consistency при работе множества команд над общими proto-контрактами.
Kubernetes и оркестрация
▼
Понимает базовые концепции Kubernetes и может документировать простые deployment конфигурации. Знает основные объекты K8s: Pod, Service, Deployment для описания инфраструктуры в руководствах. Создаёт getting started документацию по работе с кластером для разработчиков.
Документирует Kubernetes-архитектуру проекта: deployments, services, ingress, ConfigMaps с диаграммами. Создаёт руководства по деплою и управлению приложениями в K8s для DevOps-команды. Описывает troubleshooting процедуры и типичные проблемы в operational runbooks.
Проектирует стандарты Kubernetes documentation для организации: архитектурные гайды, operational playbooks. Создаёт глубокие руководства по production-ready K8s: security, networking, monitoring, scaling. Внедряет автогенерацию документации из Helm charts и Kubernetes manifests.
Определяет корпоративные стандарты документирования Kubernetes-инфраструктуры для всех проектов. Координирует создание единого K8s knowledge base с runbooks и troubleshooting guides. Внедряет documentation-as-code подход к управлению infrastructure documentation.
Prompt Engineering
▼
Использует AI для написания технической документации, API-референсов и руководств пользователя. Формулирует промпты с контекстом аудитории (разработчик vs конечный пользователь) и стилевыми гайдлайнами. Итерирует выходы AI для соответствия стандартам и тону документации.
Разрабатывает эффективные промпты для задач технического письма: генерация, рерайт, summarization, translation. Использует chain-of-thought, system prompts, output formatting. Создаёт repeatable prompt templates для команды.
Проектирует prompt pipelines для автоматизации документирования: multi-step generation, validation chains, context injection. Определяет quality metrics для AI-generated content. Оптимизирует промпты для снижения hallucination rate.
Определяет prompt engineering стратегию для документационной команды. Внедряет prompt version control и A/B testing промптов. Формирует guidelines и обучает команду эффективному prompt engineering.
System Design
▼
Понимает базовые концепции system design: client-server, load balancing, caching, database types. Знает основные architectural patterns. Умеет документировать high-level system architecture по описанию инженера.
Документирует system design решения: capacity planning, scalability patterns, failure modes. Создаёт architecture overviews для различных аудиторий (engineers, management, new hires). Визуализирует сложные системы через clear diagrams.
Создаёт комплексную system design документацию: NFR (non-functional requirements), capacity models, failure analysis, DR plans. Обеспечивает связность между system design docs, ADR и operational runbooks.
Определяет стандарты system design документации для организации. Координирует documentation cross-cutting concerns: security, performance, reliability. Обучает команды документированию архитектурных решений.
Unit-тестирование
▼
Понимает базовые концепции юнит-тестирования для документации: тестирование примеров кода в документации, проверка точности code snippets, автоматическая валидация ссылок и референсов. Следует командным практикам обеспечения компилируемости документированных примеров и получения ожидаемого результата.
Документирует тестовые стратегии проектов: описание фреймворков, конвенции, coverage requirements. Создаёт руководства по написанию юнит-тестов для SDK и API с практическими примерами. Включает тестирование примеров кода в CI pipeline документации для проверки актуальности.
Проектирует стандарты testing documentation для организации: шаблоны, best practices, автоматизация. Создаёт глубокие руководства по TDD и testing patterns с привязкой к конкретным продуктам. Внедряет систему автоматической валидации всех code samples в документации через юнит-тесты.
Определяет политику документирования тестовых стратегий для всех проектов организации. Стандартизирует формат testing guides и интегрирует тестирование документации в DevOps pipeline. Координирует создание comprehensive testing knowledge base для всех команд разработки.
Алгоритмы и структуры данных
▼
Понимает базовые алгоритмы и нотацию Big-O для корректного описания производительности API в документации. Знает основные алгоритмы поиска и сортировки, может описать их поведение в технических руководствах. Документирует ограничения и характеристики производительности простых API-методов.
Документирует алгоритмическую сложность API-методов и включает performance guidelines в справочники. Создаёт бенчмарк-документацию для сравнения различных подходов к решению задач в SDK. Описывает оптимизации и ограничения алгоритмов в архитектурных decision records.
Разрабатывает стандарты документирования алгоритмической сложности и performance characteristics API. Создаёт глубокие технические whitepapers по оптимизации алгоритмов для specific use cases продукта. Проектирует интерактивные визуализации performance benchmarks для developer portal.
Определяет политику документирования performance и алгоритмической сложности для всех API организации. Стандартизирует формат performance documentation и интегрирует бенчмарки в CI. Координирует создание comprehensive performance guides для всех продуктов компании.
Понимает базовые структуры данных: массивы, списки, словари для точного описания API и интерфейсов. Знает основные коллекции и может корректно документировать типы параметров и возвращаемых значений. Использует знания структур данных для создания понятных диаграмм и схем в документации.
Документирует сложные структуры данных в API-справочниках: вложенные объекты, деревья, графы зависимостей. Создаёт визуализации структур данных для технических руководств и архитектурной документации. Оценивает и описывает trade-off выбора структур данных в рекомендательных документах.
Разрабатывает шаблоны и стандарты документирования сложных data models и их взаимосвязей. Проектирует интерактивные визуализации структур данных для developer portals и API Explorer. Создаёт глубокие технические руководства по выбору и использованию структур данных в проектах.
Определяет стандарты документирования data models для всех проектов организации. Координирует создание единой knowledge base по структурам данных для разработчиков и архитекторов. Внедряет автогенерацию документации из schema definitions и data models.
Архитектурное управление
▼
Понимает назначение Architecture Decision Records и их роль в фиксации архитектурных решений. Знает базовую структуру ADR (контекст, решение, последствия). Умеет находить и читать существующие ADR в репозитории проекта.
Самостоятельно оформляет ADR на основе обсуждений с архитекторами и разработчиками. Следит за нумерацией, связностью и актуальностью записей. Интегрирует ADR в docs-as-code пайплайн, обеспечивая их публикацию на developer portal.
Разрабатывает процесс ведения ADR для всей организации: шаблоны, правила ревью, lifecycle-статусы (proposed, accepted, deprecated, superseded). Помогает архитекторам формулировать решения чётко и аргументированно, вычитывает контекст и последствия.
Выстраивает корпоративную практику Architecture Decision Records: governance, связь с architecture review board, интеграция в onboarding новых разработчиков. Проводит аудит существующих ADR и обеспечивает их актуальность при эволюции системы.
Архитектурные паттерны
▼
Понимает базовые принципы Clean Architecture: разделение на слои (entities, use cases, interface adapters, frameworks). Знает dependency rule и инверсию зависимостей. Умеет документировать слоистую структуру приложения.
Документирует Clean Architecture проектов: описывает назначение каждого слоя, правила зависимостей, примеры кода. Создаёт architecture decision records объясняющие выбор Clean Architecture. Помогает разработчикам понять архитектурные boundaries.
Создаёт комплексную документацию Clean Architecture для сложных систем: mapping между business capabilities и architecture layers, testing strategies per layer, dependency injection configuration. Проводит review кода на соответствие архитектурным описаниям.
Стандартизирует подходы к документированию Clean Architecture в организации. Создаёт reference implementations с подробной документацией. Обеспечивает согласованность архитектурной документации при масштабировании команд.
Понимает основы Hexagonal Architecture (Ports and Adapters): core domain, ports (inbound/outbound), adapters. Знает отличия от layered architecture. Умеет документировать структуру hexagonal-проекта по описанию архитектора.
Документирует Hexagonal Architecture проектов: описывает порты, адаптеры, domain model, use cases. Создаёт architecture guides объясняющие design decisions. Помогает разработчикам понять границы между слоями.
Создаёт комплексную документацию Hexagonal Architecture: mapping business capabilities to ports, adapter implementation patterns, testing strategies. Обеспечивает связность между architecture docs и кодовой базой.
Стандартизирует документирование архитектурных паттернов (Hexagonal, Clean, Onion) в организации. Создаёт reference documentation и template projects. Координирует единство подходов между командами.
Безопасность приложений
▼
Понимает основные OWASP-уязвимости и может документировать базовые security requirements проекта. Знает терминологию безопасности для корректного описания authentication и authorization в API-документации. Создаёт простые security guidelines для разработчиков в рамках проектной документации.
Документирует security architecture проекта: threat model, security controls, compliance requirements. Создаёт руководства по безопасной разработке на основе OWASP Top 10 для команды разработки. Описывает процедуры security review и vulnerability management в operational документации.
Проектирует стандарты security documentation для организации: threat models, security policies, compliance docs. Создаёт глубокие руководства по application security с привязкой к конкретным технологиям продукта. Внедряет автоматическую генерацию security documentation из security scanning tools.
Определяет корпоративные стандарты документирования безопасности для всех проектов организации. Координирует создание единого security knowledge base и compliance documentation repository. Внедряет documentation-driven security approach с автоматической проверкой актуальности.
Инструменты совместной работы
▼
Понимает концепцию InnerSource: применение open-source практик внутри компании. Знает роль документации в InnerSource: README, CONTRIBUTING, CODE_OF_CONDUCT. Умеет создавать базовую документацию для внутренних проектов.
Создаёт полноценную InnerSource-документацию: contribution guides, architecture overviews, getting started, API references. Помогает проектам стать discoverability-friendly через качественную документацию. Адаптирует open-source documentation best practices.
Проектирует documentation framework для InnerSource программы компании: стандарты, шаблоны, quality requirements. Создаёт internal developer portal для discoverability InnerSource-проектов. Обучает команды написанию качественной документации.
Определяет documentation стратегию для InnerSource на уровне организации. Координирует документирование cross-team проектов. Формирует culture of documentation через InnerSource practices, обучение и incentives.
Интеграционное тестирование
▼
Понимает разницу между юнит и интеграционными тестами для документирования тестовых стратегий проекта. Знает основные инструменты интеграционного тестирования и может описать процесс запуска тестов. Создаёт базовую документацию по настройке тестового окружения для разработчиков.
Документирует стратегию интеграционного тестирования проекта: инструменты, конфигурации, best practices. Создаёт руководства по написанию интеграционных тестов для API с примерами и test fixtures. Описывает CI/CD pipeline с фокусом на этапы интеграционного тестирования и requirements.
Проектирует стандарты документирования интеграционного тестирования для организации: шаблоны, примеры. Создаёт глубокие руководства по тестированию распределённых систем с практическими сценариями. Внедряет автоматическую генерацию тестовой документации из test suites и CI configuration.
Определяет корпоративные стандарты документирования integration testing для всех проектов. Координирует создание единой knowledge base по тестированию интеграций между командами. Внедряет documentation-driven testing подход с автоматической проверкой актуальности.
Контейнеризация
▼
Понимает базовые концепции Docker для документации: запуск сайта документации локально в контейнерах, Docker-based среды предпросмотра документации, базовый docker-compose для тулчейнов документации. Следует командным конвенциям контейнеризованных систем сборки документации.
Создаёт документацию по Docker-окружениям проектов: Dockerfile best practices, docker-compose конфигурации, multi-stage builds. Документирует deployment процессы с использованием контейнеров. Использует Docker для воспроизведения окружений при написании документации.
Документирует сложные контейнерные архитектуры: orchestration, networking, volume management, security best practices. Создаёт runbooks для Docker-based инфраструктуры. Автоматизирует preview-окружения документации через Docker.
Стандартизирует подходы к документированию контейнерной инфраструктуры. Определяет шаблоны документации для Docker-based проектов. Внедряет containerized documentation pipelines для масштабирования команды.
Логирование
▼
Понимает базовые концепции структурированного логирования для документации: документирование стандартов и конвенций логирования, написание разделов runbook по анализу логов, понимание схем логов для операционной документации. Следует командным конвенциям структуры и стиля документации логирования.
Документирует систему логирования проекта: форматы, уровни, correlation IDs, поля и их назначение. Создаёт руководства по troubleshooting с использованием структурированных логов для команды поддержки. Описывает интеграцию логирования с мониторингом и алертингом в operational guides.
Проектирует стандарты документирования observability: логи, метрики, трейсы для всей организации. Создаёт глубокие руководства по настройке и использованию centralized logging для разных платформ. Разрабатывает шаблоны runbook документации на основе анализа структурированных логов.
Определяет корпоративные стандарты документирования logging и observability для всех проектов. Координирует создание единого logging glossary и справочника форматов для всех команд. Внедряет автогенерацию документации из logging configuration и schema definitions.
Метрики и мониторинг
▼
Понимает назначение Prometheus и Grafana и может документировать базовые метрики и дашборды. Знает типы метрик и их формат для создания справочников по мониторингу приложений. Описывает базовую настройку мониторинга в operational руководствах проекта.
Документирует систему мониторинга проекта: метрики, дашборды, алерты с описаниями и порогами срабатывания. Создаёт runbook документацию для incident response на основе Grafana-дашбордов. Описывает интеграцию Prometheus с другими компонентами observability stack в архитектурных руководствах.
Проектирует стандарты operational documentation: runbooks, playbooks, monitoring guides для организации. Создаёт глубокие руководства по настройке observability stack для различных deployment-сценариев. Внедряет автогенерацию документации из Prometheus rules и Grafana dashboard JSON.
Определяет корпоративные стандарты operational documentation и monitoring guides для всех проектов. Координирует создание единого runbook repository с автоматическим обновлением из alerting rules. Внедряет documentation-as-code подход к operational knowledge management.
Многопоточность и конкурентность
▼
Понимает концепции async/await и callback для корректного описания асинхронных API в документации. Знает основные паттерны асинхронного программирования и может документировать Promise-based API. Создаёт простые примеры асинхронного кода для getting started руководств.
Документирует сложные асинхронные API: streaming, WebSocket, event-driven интерфейсы с практическими примерами. Создаёт руководства по обработке ошибок в асинхронном коде для разработчиков. Описывает паттерны concurrency и parallel execution в архитектурной документации.
Проектирует стандарты документирования асинхронных API и event-driven архитектур для организации. Создаёт интерактивные playground для тестирования асинхронных API-вызовов в developer portal. Разрабатывает глубокие руководства по troubleshooting race conditions и async-ошибок.
Определяет стандарты описания асинхронных паттернов и concurrency для всей документации организации. Координирует единый подход к документированию event-driven и stream-based API между командами. Внедряет автоматическую генерацию примеров async-кода из OpenAPI-спецификаций.
Облачные провайдеры
▼
Понимает базовые сервисы AWS и может документировать простые инфраструктурные конфигурации. Знает основные компоненты облачной архитектуры для описания deployment process в руководствах. Создаёт getting started документацию по настройке AWS-окружения для разработчиков.
Документирует облачную архитектуру проекта на AWS: сервисы, сети, security groups с диаграммами. Создаёт руководства по деплою и настройке AWS-сервисов для команды DevOps и разработчиков. Описывает cost optimization и scaling strategies в architectural decision records.
Проектирует стандарты cloud documentation для организации: архитектурные диаграммы, runbooks, IaC docs. Создаёт глубокие руководства по AWS Well-Architected Framework в контексте продуктов компании. Внедряет автогенерацию infrastructure documentation из CloudFormation/Terraform.
Определяет корпоративные стандарты документирования облачной инфраструктуры для всех проектов. Координирует создание единого cloud architecture catalog с описаниями и compliance requirements. Внедряет documentation-as-code подход к управлению инфраструктурной документацией.
ООП и паттерны проектирования
▼
Знает базовые паттерны проектирования и может корректно использовать их названия в технической документации. Понимает назначение основных паттернов для точного описания архитектурных решений в API-справочниках. Создаёт простые диаграммы паттернов для визуализации архитектуры в руководствах.
Документирует применение паттернов проектирования в архитектуре продукта с примерами и обоснованиями. Создаёт архитектурные руководства, описывающие выбор паттернов и их trade-off для разработчиков. Разрабатывает каталог паттернов проекта с примерами кода и рекомендациями по использованию.
Проектирует стандарты архитектурной документации с описанием паттернов на уровне организации. Создаёт глубокие whitepapers и ADR по применению паттернов в контексте масштабных продуктов. Разрабатывает интерактивные визуализации архитектурных паттернов для developer education.
Определяет стандарты документирования архитектурных решений и паттернов для всех проектов компании. Координирует создание corporate pattern library с описаниями, примерами и decision criteria. Внедряет Architecture Decision Records как стандартную практику документирования.
Понимает базовые принципы ООП для корректного описания классов, интерфейсов и иерархий в API-документации. Знает термины инкапсуляции, наследования и полиморфизма для точного использования в технических текстах. Создаёт простые UML-диаграммы для визуализации объектных моделей в документации.
Документирует сложные объектные модели с описанием паттернов, интерфейсов и взаимосвязей классов. Создаёт архитектурные руководства по использованию ООП-принципов в SDK и библиотеках проекта. Разрабатывает примеры кода, демонстрирующие правильное применение SOLID-принципов для разработчиков.
Проектирует стандарты документирования объектных моделей и архитектурных решений в ООП-проектах. Создаёт глубокие технические руководства по применению паттернов проектирования в контексте продукта. Разрабатывает интерактивные визуализации архитектуры и class diagrams для developer portal.
Определяет стандарты архитектурной документации для всех ООП-проектов организации. Координирует создание единого glossary терминов объектного проектирования для всех команд. Внедряет автоматическую генерацию документации из аннотированного ООП-кода.
Паттерны микросервисов
▼
Понимает основы микросервисной архитектуры и её отличия от монолита. Знает ключевые концепции: bounded context, service boundaries, inter-service communication. Умеет документировать отдельный микросервис по шаблону.
Документирует микросервисную архитектуру: service catalog, dependency maps, communication patterns (sync/async). Создаёт onboarding guides для новых разработчиков. Документирует service contracts и integration patterns.
Проектирует систему документирования микросервисного ландшафта: automated service registry docs, event catalog, cross-service sequence diagrams. Обеспечивает документация отражает реальное состояние системы через auto-generation.
Определяет стандарты документирования микросервисов для организации. Каждый сервис имеет обязательный набор документации. Координирует документирование cross-cutting concerns: observability, security, deployment.
Протоколы API
▼
Понимает технологию Server-Sent Events: однонаправленный поток данных от сервера к клиенту. Знает отличия SSE от WebSocket и long polling. Умеет документировать формат SSE-событий и поля (event, data, id, retry).
Создаёт документацию для SSE API: event catalog, connection management, error handling, reconnection strategy. Пишет code examples подключения к SSE на JavaScript, Python, curl. Документирует best practices использования SSE.
Документирует сложные SSE-паттерны: event sourcing, load balancing SSE connections, scaling strategies. Создаёт interactive documentation для SSE: live event preview, playground. Обеспечивает documentation coverage streaming API.
Определяет стандарты документирования streaming API (SSE, WebSocket, gRPC streaming) для организации. Обеспечивает consistency подходов к документированию real-time коммуникации между командами.
Понимает технологию WebSocket: full-duplex коммуникация, handshake, frames. Знает отличия от HTTP, SSE, long polling. Умеет документировать WebSocket events и message format для простого real-time API.
Создаёт документацию для WebSocket API: connection lifecycle, message protocol, authentication, reconnection strategy. Пишет code examples на JavaScript и Python. Документирует error handling и rate limiting для WebSocket.
Документирует сложные WebSocket-архитектуры: pub/sub patterns, room-based communication, binary protocols. Создаёт comprehensive real-time API documentation. Разрабатывает testing guides для WebSocket integrations.
Определяет стандарты документирования real-time API для организации. Координирует единый подход к документированию WebSocket, SSE и gRPC streaming. Обеспечивает developer experience для real-time integrations.
Реляционные БД
▼
Понимает базовые концепции PostgreSQL для документации: документирование схем БД и моделей данных, написание примеров запросов для документации API, понимание связей таблиц для диаграмм потоков данных. Следует командным конвенциям стандартов документирования БД.
Документирует схемы баз данных проекта: таблицы, связи, индексы, миграции с ER-диаграммами. Создаёт руководства по работе с PostgreSQL для разработчиков: best practices, конвенции, типичные запросы. Описывает процессы backup, restore и maintenance в operational документации.
Проектирует стандарты database documentation для организации: schema docs, migration guides, runbooks. Создаёт глубокие руководства по оптимизации PostgreSQL с performance benchmarks и рекомендациями. Внедряет автогенерацию database documentation из DDL и migration scripts.
Определяет корпоративные стандарты документирования баз данных для всех проектов организации. Координирует создание единого database knowledge base с автоматическим обновлением из schema changes. Внедряет documentation-driven database management с версионированием schema docs.
Управление API
▼
Понимает структуру API-документации: описание эндпоинтов, параметры запросов, форматы ответов, коды ошибок. Знает основные инструменты: Swagger UI, Redoc, Postman. Умеет читать и дополнять существующую API-документацию.
Самостоятельно создаёт полноценную API-документацию на базе OpenAPI/Swagger спецификаций. Документирует аутентификацию, rate limiting, пагинацию, версионирование. Пишет getting started guides и tutorials для API consumers.
Проектирует информационную архитектуру API-документации для сложных продуктов: multi-API портал, versioned docs, SDK references. Внедряет автогенерацию из кода с ручным обогащением описаниями и примерами. Обеспечивает consistency через style guide и linting.
Определяет стандарты API-документирования для организации: templates, review процессы, quality gates. Координирует работу нескольких технических писателей над крупным API-портфелем. Внедряет метрики качества документации (completeness, accuracy, freshness).
Понимает зачем нужно версионирование API и основные подходы: URI versioning, header versioning, query parameter versioning. Знает принципы семантического версионирования. Умеет документировать версию API в спецификации.
Документирует различия между версиями API: changelog, breaking changes, migration path. Создаёт versioned documentation с переключателем версий. Описывает deprecation policy и sunset timeline для устаревших версий.
Разрабатывает документационную стратегию для multi-version API: как поддерживать несколько версий одновременно, как мигрировать пользователей. Создаёт migration guides с code diff примерами и compatibility matrices. Автоматизирует генерацию changelogs.
Определяет организационные стандарты документирования версионирования API: шаблоны changelog, deprecation notices, communication plan для партнёров. Обеспечивает согласованность практик версионирования документации по всем API-продуктам.
Чистый код и рефакторинг
▼
Понимает базовые метрики качества кода и их влияние на создание понятной документации. Знает принципы чистого кода и использует их для написания качественных примеров в документации. Оценивает читаемость кода при выборе фрагментов для технических руководств.
Анализирует качество кода документируемых проектов для определения приоритетов документирования. Использует линтеры и статический анализ для автоматической проверки примеров кода в документации. Создаёт руководства по coding standards с акцентом на самодокументируемый код.
Проектирует систему метрик качества кода, влияющих на документационные процессы организации. Внедряет автоматическую валидацию примеров кода в документации через CI/CD pipeline. Разрабатывает стандарты self-documenting code для минимизации потребности во внешней документации.
Определяет взаимосвязь между метриками качества кода и качеством документации на уровне проекта. Стандартизирует инструменты анализа качества кода для нужд документационной команды. Внедряет автоматические проверки соответствия кода и документации в CI-процесс.