Роли · Technical Writer · Middle
10 ключевых навыков, всего 45. Ожидания по каждому навыку и что меняется на следующем уровне.
На этой странице — что ожидается от Middle }, навык за навыком. Ключевые навыки оценивают руководитель и коллеги в цикле ревью; остальные учитываются только в самооценке. Основные области: API и интеграции, Контроль версий и коллаборация, Документация.
Сгруппированы по областям. Метка справа — ожидаемая глубина: Осведомлённость, Применение, Продвинутый или Эксперт.
Создаёт полноценную REST API-документацию в OpenAPI/Swagger: paths, schemas, security, examples. Документирует API design conventions: naming, pagination, filtering, error format. Настраивает Swagger UI / Redoc для интерактивной документации.
Полноценно работает по docs-as-code workflow: branch → write → PR → review → merge → deploy. Настраивает CI/CD для автоматической сборки и публикации документации. Использует linting (markdownlint, vale) для контроля качества текста.
Пишет полноценные API-гайды: quickstart, authentication flow, error handling, use cases. Создаёт code samples на нескольких языках (curl, Python, JavaScript, Go). Следит за consistency терминологии и стиля во всех разделах API docs.
Создаёт полноценную архитектурную документацию совместно с архитекторами: system context, container diagrams, component diagrams (C4). Документирует data flows, интеграции со внешними системами, deployment topology. Поддерживает документацию в актуальном состоянии.
Создаёт сложные технические диаграммы: C4 model (все 4 уровня), data flow diagrams, state machines, ER-диаграммы. Использует diagrams-as-code инструменты (Mermaid, PlantUML). Следит за визуальной consistency и читаемостью диаграмм.
Уверенно работает с 2-3 docs-as-code фреймворками. Настраивает navigation, search, versioning, custom components. Использует MDX/RST расширения, плагины для diagrams, code highlighting. Интегрирует docs build в CI/CD.
Проектирует информационную архитектуру knowledge base: taxonomy, navigation, search optimization. Создаёт content governance: templates, naming conventions, review процессы. Обеспечивает актуальность контента через scheduled reviews.
Самостоятельно создаёт runbook-и для production-систем: deployment procedures, incident response, disaster recovery. Обеспечивает пошаговость и однозначность инструкций. Проводит dry-run тестирование runbook-ов с операционной командой.
Регулярно пишет технические посты: deep-dive статьи, comparison articles, best practices guides. Оптимизирует контент для SEO и developer audience. Работает с CMS (WordPress, Ghost, dev.to). Создаёт контент-план для engineering blog.
Создаёт полноценную пользовательскую документацию: information architecture, content hierarchy, cross-references. Пишет для разных аудиторий (beginners, advanced users, admins). Использует user feedback для улучшения документации.
Команда их не оценивает, но они входят в самооценку и план развития.
45 навыков получают более высокое ожидание или становятся ключевыми при переходе с Middle на Senior. Сначала самые большие скачки.
} в открытой матрице компетенций: 45 навыков на 5 уровнях. Матрица бесплатна для специалистов и останется бесплатной.