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

tech-docs-writer — субагент для Claude Code: функции и установка

Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода.

лицензия не указана ★ 1 064 обновлён 2026-01-21

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

Что делает tech-docs-writer

Субагент изучает структуру репозитория через параллельные вызовы поиска и чтения файлов. Он готовит документацию четырёх типов: обзорные файлы README, спецификации эндпоинтов API, описания архитектуры с потоками данных и руководства пользователя. В конфигурации прописана модель Sonnet.

Работа строится по шагам. Агент может брать задачи напрямую из файла со списком дел (например, docs/ai-todo.md), фиксировать текущий статус и готовить финальный отчёт с перечнем затронутых путей. При формировании коммитов он ориентируется на стиль сообщений из git log.

Главное правило субагента — проверка на практике. Он обязан протестировать команды запуска и примеры запросов к API перед сдачей работы. Если пример не получается выполнить локально, агент прямо фиксирует это ограничение в тексте, не маскируя пробелы.

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

  • актуализировать устаревший файл README и команды установки
  • описать параметры и ответы нового эндпоинта API
  • задокументировать архитектуру и потоки данных для нового модуля
  • разобрать задачи по документации из файла todo со сверкой примеров

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

  • Проверь README и обнови шаги установки под текущую версию проекта.
  • Я реализовал маршрут /users/export, напиши для него документацию API с примерами.
  • Выполни следующую задачу по документации из файла docs/ai-todo.md.

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

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

.claude/agents/tech-docs-writer.md

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

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

Вопросы о tech-docs-writer

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

Разместите файл субагента по пути .claude/agents/tech-docs-writer.md в проекте. После этого Claude Code сможет подключать его для инженерных текстов.

Что делает субагент tech-docs-writer?

Он анализирует исходный код и создаёт технические тексты: справочники API, архитектурные заметки, обучающие руководства и описания репозиториев.

Какую языковую модель использует агент?

В метаданных агента явно задана модель Sonnet. Она отвечает за глубокий разбор логики и форматирование итоговых markdown-файлов.

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

Все субагенты по теме «Тексты и документация» →
docs-writer justxor Субагент docs-writer автоматически актуализирует README, API-документацию, комментарии и ADR когда вы меняете код. Проверяет фактическое поведение и держит примеры в синхронизации с реальностью. CX Codex ★ 353звёзд репо SE: Tech Writer официальный github SE: Tech Writer — субагент для GitHub Copilot: пишет технические руководства и проектную документацию, включая ADR, и структурирует базу знаний. CX Codex +1 ★ 41 430звёзд репо agent-technical-writer Tony363 Скилл agent-technical-writer для Claude Code пишет API-документацию, гайды и технические материалы. Подключается к задачам технического писателя и подготовке технических рекомендаций. CX Codex +1 108установок Tech Writer lucagonzalez Промпт Tech Writer для ChatGPT и Claude.ai превращает черновые шаги работы с приложением в готовую инструкцию. Берёт список действий — возвращает текст статьи. GP ChatGPT ★ 178 201звёзд репо code-documentation-analyzer Jeremy Longshore Автоактивируемый скилл для разбора документации кода: API-справочники, руководства пользователя, архитектурные описания. Включается по фразам вроде «code documentation analyzer» или «code analyzer». CX Codex +1 1установок documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок

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

Весь набор →
rendering-content-visibility Правило rendering-content-visibility для Claude Code предлагает применять content-visibility: auto к длинным спискам. Браузер откладывает отрисовку элементов за пределами экрана. CX Codex +1 ★ 1 064звёзд репо rerender-dependencies Правило rerender-dependencies для Claude требует держать в зависимостях useEffect примитивы: user.id вместо user. Тогда эффект не перезапускается на каждое изменение полей объекта. CX Codex +1 ★ 1 064звёзд репо testing Правило testing задаёт структуру тестов для TypeScript-файлов с тестами и каталога __tests__. Оно пригодится, когда нужно проверить успешные сценарии, ошибки и граничные случаи. CX Codex +1 ★ 1 064звёзд репо forge Правило forge настраивает работу Foundry с Abstract и подсказывает Claude Code использовать ZKsync-режим для Solidity-проектов. CX Codex +1 ★ 1 064звёзд репо js-batch-dom-css Правило js-batch-dom-css для Claude: не менять стили по одному свойству, а собирать их в класс или одну строку cssText, чтобы браузер реже пересчитывал раскладку. CX Codex +1 ★ 1 064звёзд репо codebase-search Субагент codebase-search ищет, где в проекте лежит нужная логика, и возвращает абсолютные пути с объяснением потока. CX Codex ★ 1 064звёзд репо media-interpreter Субагент media-interpreter для работы с PDF, изображениями, диаграммами и другими бинарными форматами. Извлекает текст, данные таблиц и описания визуального контента, когда обычное чтение файла не подходит. CX Codex ★ 1 064звёзд репо open-source-librarian Субагент open-source-librarian для Claude Code исследует open-source библиотеки и код, находит реализацию и даёт ссылки на строки GitHub. Отвечает на вопросы об устройстве и истории изменений. CX Codex ★ 1 064звёзд репо

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

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