Роли · Technical Writer · Junior
10 ключевых навыков, всего 45. Ожидания по каждому навыку и что меняется на следующем уровне.
На этой странице — что ожидается от Junior }, навык за навыком. Ключевые навыки оценивают руководитель и коллеги в цикле ревью; остальные учитываются только в самооценке. Основные области: API и интеграции, Контроль версий и коллаборация, Документация.
Сгруппированы по областям. Метка справа — ожидаемая глубина: Осведомлённость, Применение, Продвинутый или Эксперт.
Понимает принципы REST API: HTTP-методы, статус-коды, URI-структура, JSON. Знает OpenAPI/Swagger спецификацию на базовом уровне. Умеет документировать простые CRUD-эндпоинты с параметрами и ответами.
Понимает принцип documentation-as-code: документация хранится в Git, версионируется вместе с кодом, проходит review через pull requests. Умеет создавать и редактировать Markdown-файлы в репозитории, отправлять PR с изменениями документации.
Понимает принципы написания developer-friendly API-описаний: ясность, полнота, примеры использования. Знает разницу между reference docs и conceptual guides. Умеет писать описания параметров и полей в понятном стиле.
Понимает основные типы архитектурной документации: system overview, component diagrams, sequence diagrams, deployment diagrams. Знает нотацию C4 model на базовом уровне. Умеет документировать простые архитектурные решения по шаблону.
Владеет базовыми инструментами диаграммирования: draw.io, Lucidchart, Miro. Умеет создавать простые диаграммы: блок-схемы, sequence diagrams, mind maps. Знает основные нотации: UML basics, flowcharts, network diagrams.
Знает основные docs-as-code инструменты: MkDocs, Docusaurus, Sphinx, Hugo, Jekyll. Умеет настроить базовый documentation site из шаблона. Пишет документацию в Markdown, знает основы reStructuredText.
Понимает назначение knowledge base для технической команды. Знает популярные инструменты: Confluence, Notion, GitBook, Bookstack. Умеет структурировать информацию в wiki: создавать страницы, ссылки, таблицы, шаблоны.
Понимает назначение runbook-ов и их роль в incident response. Знает структуру runbook: предусловия, шаги, проверки, rollback. Умеет документировать простые операционные процедуры по описанию инженера.
Понимает форматы технического блоггинга: tutorials, how-to guides, case studies, announcements. Знает основы SEO для технического контента. Умеет писать простые технические посты с code examples и скриншотами.
Понимает принципы создания пользовательской документации: clarity, task-oriented approach, progressive disclosure. Знает типы user docs: getting started, tutorials, how-to, reference. Умеет писать пошаговые инструкции для конечных пользователей.
Команда их не оценивает, но они входят в самооценку и план развития.
45 навыков получают более высокое ожидание или становятся ключевыми при переходе с Junior на Middle. Сначала самые большие скачки.
} в открытой матрице компетенций: 45 навыков на 5 уровнях. Матрица бесплатна для специалистов и останется бесплатной.