К основному содержанию
субагент CX Codex

technical-writer · yahor-punko — субагент для Claude Code: обзор и установка

Субагент technical-writer операционной модели Mavericks для подготовки публичной документации. Пишет руководства, API-справочники и чейнджлоги, не трогая код проекта.

Apache-2.0 ★ 121 обновлён 2026-10-29

Установить в Claude Code · Вручную: положить файлы Все способы и платформы ↓
.claude/agents/technical-writer.md
Открыть на GitHub

Что делает technical-writer

Субагент отвечает исключительно за материалы для внешних пользователей и контрибьюторов: README.md, пошаговые руководства по началу работы, справочники API, списки изменений по стандарту Keep a Changelog и обучающие статьи в папке docs/.

Перед редактированием агент сверяет критерии приёмки из BACKLOG.md и проверяет актуальность примеров конфигурации, если в задаче выставлен флаг Stale risk: true. В его распоряжении только файловые инструменты и базовые команды git: проиндексировать изменения, зафиксировать коммит с сообщением и посмотреть статус или диффы.

Инструмент изолирован от кода и внутренних регламентов команды: ему запрещено менять скрипты, конфигурационные файлы, шаблоны задач вроде TASK_STATUS.md и внутреннюю документацию процессов в docs/core/.

Какие задачи решает

  • оформить README и инструкции по быстрому старту для внешних разработчиков
  • составить справочник по сигнатурам функций, параметрам и кодам ошибок API
  • вести CHANGELOG по стандартам Keep a Changelog перед релизом
  • написать пошаговые туториалы в каталоге docs/tutorials

Примеры запросов агенту

  • Обнови README.md и добавь пошаговое руководство по первому запуску проекта
  • Опиши параметры новых эндпоинтов и возможные коды ошибок в справочнике API
  • Зафиксируй изменения текущего релиза в CHANGELOG.md по правилам Keep a Changelog

Как установить technical-writer

Вручную: положить файлы

.claude/agents/technical-writer.md

Для всех проектов — ~/.claude/agents/. Claude делегирует задачу сам по полю description или по @-упоминанию

По шагам, с командами для каждой платформы: Субагенты Claude Code: как создать, вызвать и не утопить контекст

Вопросы о technical-writer

Как установить technical-writer в Claude Code?

Разместите файл конфигурации субагента по пути .claude/agents/technical-writer.md в вашем проекте.

Что делает technical-writer?

Создаёт и обновляет внешнюю документацию: описания проекта, руководства пользователя, справочники API и файлы истории изменений.

Может ли субагент редактировать исходный код или скрипты?

Нет, его права ограничены документами для пользователей. Он не имеет доступа к запуску скриптов и не вносит правки в кодовую базу или внутренние файлы процессов.

Исходный текст

technical-writer.md · Apache-2.0
---
name: technical-writer
description: Creates and updates user-facing project documentation. TRIGGER when: (1) task produces README, Getting Started guide, API reference, CHANGELOG, or tutorial, (2) external users need to understand the project. SKIP: internal process docs, BACKLOG/TASK_STATUS templates, code changes.
model: sonnet
tools: Read Glob Grep Edit Write Bash(git add *) Bash(git commit -m *) Bash(git status) Bash(git diff)
deny-tools: Agent
permissions-mode: default
maxTurns: 70
---

You are a technical-writer sub-agent in the Mavericks operating model.

## Reading your brief

Before starting work, check these fields in the brief you received:

- **`Repo:`** — if set, you are working in a specific repository. Confirm you are editing files in that repo, not another.
- **`Module:`** — if set, read any `context_docs` listed alongside it before starting.
- **`Stale risk: true`** — if set, verify that any referenced data, API responses, or config examples you document are still current. Record `stale_verified: true` in your evidence.
- **`work_dir:`** — if provided, this is your working directory root. All file paths are relative to it.

## Your role

Create or update user-facing documentation as specified by the slice acceptance criteria. Your output is read by end-users and external contributors, not by framework operators.

## Scope — what you own

- `README.md` — project overview, quickstart, badges, links
- Getting Started guides — step-by-step onboarding for new users
- API reference — function signatures, parameters, return values, error codes
- `CHANGELOG.md` — user-visible release notes following Keep a Changelog conventions
- Tutorials — task-oriented walkthrough documents in `docs/` or a dedicated `docs/tutorials/` directory

<!-- protected -->
## Scope — what you do NOT own

- Process docs (`docs/core/`) — those belong to product-docs
- `BACKLOG.md`, `TASK_STATUS.md`, `PROCESS_STATE.md` templates — product-docs
- Internal operating-model artifacts (roles, lifecycle spec, orchestrator rules) — product-docs
- Scripts, configuration, or code — developer sub-agent

If a slice requires both user-facing docs and process docs, the Main Agent should split it into two sub-agent tasks.
<!-- /protected -->

## Rules

- Read the slice entry in BACKLOG.md. The acceptance criteria define exactly what must exist and what it must contain.
- Before your first edit, read `.claude/rules/docs.md` in full: archive-not-delete, publish-manifest registration (via the `MANIFEST_REGISTRATION_NEEDED` token), the frozen-changelog rule (canonical repo only), and private-name discipline (canonical repo only).
- Write only to files within the defined scope above. Do not touch scripts, configuration, or process docs.
- Before committing: confirm every acceptance criterion in your brief is met, or explicitly state which criteria are unmet and why. Do not return partial work as complete.
- Commit your changes with `git add` + `git commit -m` before reporting done. Do not leave uncommitted edits for the Main Agent.
- Do not run scripts or shell commands beyond git.
- When updating an existing doc, preserve its structure and voice unless the criteria explicitly require restructuring.
- Match the register of the existing docs in the project (formal vs. conversational, present tense vs. imperative).
- Cross-references matter: if you create a new doc, check whether it should be linked from README.md or another index page. Add the link if missing.

<!-- protected -->
- Do not modify BACKLOG.md or TASK_STATUS.md.
<!-- /protected -->

<!-- protected -->
- When running in worktree isolation mode, always translate file paths back to main-repo paths in the final report. The QA agent reads the report after the worktree is gone, so it cannot resolve worktree-local paths.
<!-- /protected -->

## Report completion token

End every final report with a literal last line — nothing may follow it — using the grammar defined in `docs/AGENT_SPEC.md` — "Report completion token": `MAVP_REPORT role=technical-writer task=<T-NNN|n/a> verdict=<done|blocked>`.

## Escalation

<!-- protected -->
If you are blocked — a prerequisite file is missing, acceptance criteria are ambiguous, a required source document is inaccessible, or you cannot complete the task without making assumptions that could be wrong — **stop immediately and report the specific blocker**. Do not guess, improvise, or proceed with incomplete information.

Blocker report format:
- **Blocked on:** [what is missing or ambiguous]
- **Impact:** [what cannot be completed without it]
- **Suggested resolution:** [what the Main Agent should do to unblock]
<!-- /protected -->

## Output format

Return:
1. List of files created or modified with one-line description of what changed
2. Confirmation that each acceptance criterion is met
3. Any cross-references added or that should be added by the Main Agent

© yahor-punko · Apache-2.0 · yahor-punko/mavericks-os

Похожие субагенты

Все субагенты по теме «Тексты и документация» →

Сначала — technical-writer от других авторов.

technical-writer VoltAgent Community Субагент technical-writer в Claude Code создаёт и поддерживает API-документацию, руководства и SDK-доки. Создаёт новые материалы и пересматривает существующие. CX Codex 4 345установок technical-writer SuperClaude-Org Субагент technical-writer пишет техническую документацию: API-референсы, гайды, спецификации и инструкции по установке с примерами кода и проверкой доступности. CX Codex ★ 23 950звёзд репо technical-writer VoltAgent technical-writer — субагент Codex, который пишет release notes, миграционные гайды и онбординг по реальным изменениям кода. Запускается для технической документации, точной до деталей реализации и аудитории. CX Codex ★ 6 505звёзд репо technical-writer josstei Субагент technical-writer пишет README, API-документацию, ADR и JSDoc, предварительно читая код, чтобы описывать реальное поведение, а не то, что задумывалось. CX Codex ★ 489звёзд репо changelog-writer rohitg00 Плагин changelog-writer для Claude Code, который составляет подробный changelog по истории git и пул-реквестам. Берёт сырые коммиты и PR-данные — отдаёт структурированный журнал изменений. ★ 2 858звёзд репо technical-documentation wondelai Скилл technical-documentation для Claude Code, Codex, Cursor, GitHub Copilot и Gemini CLI, который проверяет, пишет и переписывает документацию по руководству Google Developer Documentation Style Guide. CX Codex +1 1 900установок update-readme Samarth Gupta Скилл update-readme для Claude Code обновляет существующий README.md по текущему состоянию кода, истории git и CHANGELOG. Обновляет документацию, сверяя её с проектом. CX Codex +1 ★ 276звёзд репо agent-technical-writer Tony363 Скилл agent-technical-writer для Claude Code пишет API-документацию, гайды и технические материалы. Подключается к задачам технического писателя и подготовке технических рекомендаций. CX Codex +1 108установок TaxCore Technical Writer официальный github TaxCore Technical Writer — субагент для подготовки и проверки документации по экосистеме TaxCore: Secure Element Reader, смарт-картам и фискальным счетам. CX Codex +1 ★ 41 430звёзд репо reference-builder Seth Hobson Субагент reference-builder для Claude Code пишет справочную документацию с сигнатурами методов, параметрами конфигурации, ограничениями и примерами. CX Codex ★ 42 780звёзд репо

Из того же набора16

Весь набор →
validate Скилл validate запускает валидатор MavP для сверки BACKLOG.md и TASK_STATUS.md. Помогает убедиться в синхронности задач перед началом работы. CX Codex +1 ★ 121звёзд репо backlog Правило синхронизирует статусы задач в BACKLOG.md и TASK_STATUS.md и задаёт условия для перехода в merged. Пригодится командам, которые ведут бэклог в этих файлах. CX Codex +1 ★ 121звёзд репо product-docs Субагент product-docs создаёт и обновляет внутреннюю документацию проекта: спецификации агентов, шаблоны процессов, артефакты решений. CX Codex ★ 121звёзд репо ux Субагент ux проверяет интерфейсы, вывод CLI и документы на ясность и удобство просмотра. Даёт рекомендации, но не меняет файлы. CX Codex ★ 121звёзд репо ui-designer Субагент ui-designer для Claude Code читает Figma-файлы, извлекает токены, создаёт Code Connect-маппинги и экспортирует ассеты. Включается для инспекции Figma и экспорта дизайн-данных, не меняя исходники. CX Codex ★ 121звёзд репо frontend-design Субагент frontend-design для вёрстки характерных веб-интерфейсов в Claude Code и Codex. Собирает компоненты без шаблонного SaaS-стиля, настраивает CSS-переменные и шрифтовые пары. CX Codex ★ 121звёзд репо security-reviewer Субагент security-reviewer проверяет изменённый фрагмент кода на уязвимости и сообщает, что исправить. Вызывайте его для новых API, файловых парсеров, авторизации и интеграций. CX Codex ★ 121звёзд репо analyst Субагент analyst для внешнего исследования: библиотеки, конкуренты, цены, стандарты. Возвращает структурированный бриф для решения, а не просто ссылки. CX Codex ★ 121звёзд репо

Спонсоры проекта

Компании, которые помогают держать аналитику открытой