К основному содержанию
скилл CX Codex

docs-writer — скилл для Claude Code: что делает и как установить

Скилл docs-writer для Claude Code пишет, редактирует и проверяет документацию в проекте. Работает с README, Markdown-файлами и страницами docs/.

MIT ★ 7 191 обновлён 2026-10-24

Установить в Claude Code · Через Skills CLI (Vercel) Все способы и платформы ↓
npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code
Открыть на GitHub

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

docs-writer помогает создавать и править техническую документацию. Он просит агента понять задачу, проверить код в packages/, найти нужные файлы в docs/ и учесть связанные страницы, ссылки и docs/sidebar.json.

При работе с текстом скилл опирается на CONTRIBUTING.md и references/style-guide.md. Для изменений он использует replace и write_file, затем перечитывает файлы и проверяет ссылки. В конце предлагает запустить npm run format.

Для комментариев к коду, inline JSDoc и генерации API reference этот скилл не предназначен.

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

  • написать README для новой функции
  • проверить Markdown-файл на ясность и стиль
  • обновить страницы в docs/ после изменения кода
  • сверить ссылки и docs/sidebar.json с документацией

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

  • Напиши документацию для новой функции и сначала изучи код в packages/.
  • Проверь этот README по правилам из references/style-guide.md и исправь найденные проблемы.
  • Обнови страницы в docs/, проверь связанные ссылки и предложи запустить npm run format.

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

1Через Skills CLI (Vercel)

npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code

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

~/.claude/skills/docs-writer/SKILL.md

Папка скилла целиком; для одного проекта — .claude/skills/docs-writer/

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

Вопросы о docs-writer

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

Выполните npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-code, затем используйте файл ~/.claude/skills/docs-writer/SKILL.md.

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

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

Подходит ли docs-writer для комментариев в коде и API reference?

Нет. Скилл предназначен для файлов документации, README и Markdown, а не для комментариев к коду, inline JSDoc или генерации API reference.

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

SKILL.md · MIT
---
name: docs-writer
description: Write, review, and edit documentation files with consistent structure, tone, and technical accuracy. Use when creating docs, reviewing markdown files, writing READMEs, updating `/docs` directories, or when user says "write documentation", "review this doc", "improve this README", "create a guide", or "edit markdown". Do NOT use for code comments, inline JSDoc, or API reference generation.
---

# `docs-writer` skill instructions

As an expert technical writer and editor, your goal is to produce and refine documentation that is accurate, clear, consistent, and easy for users to understand. You must adhere to the documentation contribution process outlined in `CONTRIBUTING.md`.

## Step 1: Understand the goal and create a plan

1. **Clarify the request:** Fully understand the user's documentation request. Identify the core feature, command, or concept that needs work.
2. **Differentiate the task:** Determine if the request is primarily for **writing** new content or **editing** existing content. If the request is ambiguous (e.g., "fix the docs"), ask the user for clarification.
3. **Formulate a plan:** Create a clear, step-by-step plan for the required changes.

## Step 2: Investigate and gather information

1. **Read the code:** Thoroughly examine the relevant codebase, primarily within the `packages/` directory, to ensure your work is backed by the implementation and to identify any gaps.
2. **Identify files:** Locate the specific documentation files in the `docs/` directory that need to be modified. Always read the latest version of a file before you begin work.
3. **Check for connections:** Consider related documentation. If you change a command's behavior, check for other pages that reference it. If you add a new page, check if `docs/sidebar.json` needs to be updated. Make sure all links are up to date.

## Step 3: Write or edit the documentation

1. **Follow the style guide:** Adhere to the rules in `references/style-guide.md`. Read this file to understand the project's documentation standards.
2. Ensure the new documentation accurately reflects the features in the code.
3. **Use `replace` and `write_file`:** Use file system tools to apply your planned changes. For small edits, `replace` is preferred. For new files or large rewrites, `write_file` is more appropriate.

### Sub-step: Editing existing documentation (as clarified in Step 1)

- **Gaps:** Identify areas where the documentation is incomplete or no longer reflects existing code.
- **Tone:** Ensure the tone is active and engaging, not passive.
- **Clarity:** Correct awkward wording, spelling, and grammar. Rephrase sentences to make them easier for users to understand.
- **Consistency:** Check for consistent terminology and style across all edited documents.

## Step 4: Verify and finalize

1. **Review your work:** After making changes, re-read the files to ensure the documentation is well-formatted, and the content is correct based on existing code.
2. **Link verification:** Verify the validity of all links in the new content. Verify the validity of existing links leading to the page with the new content or deleted content.
3. **Offer to run npm format:** Once all changes are complete, offer to run the project's formatting script to ensure consistency by proposing the command: `npm run format`

© tech-leads-club · MIT · tech-leads-club/agent-skills

Похожие скиллы

Все скиллы по теме «Тексты и документация» →
tech-docs-writer jarrodwatts Субагент tech-docs-writer исследует кодовую базу, пишет и обновляет README, архитектурные гайды и спецификации API с обязательной проверкой примеров кода. CX Codex ★ 1 064звёзд репо documentation-writer официальный github Скилл documentation-writer для создания технической документации по фреймворку Diátaxis: туториалы, гайды, справки и объяснения. Предлагает структуру перед написанием. CX Codex +1 27 757установок reference-docs existential-birds Скилл reference-docs помогает писать справочные страницы для API и функций: таблицы параметров, возвращаемые значения, ошибки, запускаемые примеры. CX Codex +1 121установок google-dev-docs surendranb Скилл google-dev-docs для Claude Code задаёт стиль Google для техдокументации: заголовки-действия, обращение на «вы», настоящее время, активный залог. Применяется при написании README, туториалов и справок по API. CX Codex +1 ★ 57звёзд репо ns-docs-writer nextstage-brasil Скилл ns-docs-writer для Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI и OpenCode, который пишет человекочитаемую документацию проекта: README, руководства в docs/, ранбуки и инструкции для контрибьюторов. CX Codex +1 151установок docs-style existential-birds Скилл docs-style задаёт правила редполитики для технической документации: выбор формата по Diataxis, активный залог и структура для людей и нейросетей. CX Codex +1 180установок

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

Весь набор →
state-decouple-implementation Правило state-decouple-implementation для Claude Code: провайдер управляет стейтом, UI-компонент знает только интерфейс контекста. Одна смена провайдера — useState, Zustand или серверный sync — не трогает ни одного UI-компонента. CX Codex +1 ★ 7 191звёзд репо rerender-functional-setstate Правило rerender-functional-setstate подсказывает использовать функциональное обновление React-состояния, когда новое значение зависит от текущего. Это помогает избежать устаревших замыканий в обработчиках. CX Codex +1 ★ 7 191звёзд репо state-lift-state Правило state-lift-state учит выносить состояние React в компонент-провайдер, чтобы соседние компоненты вне основного UI читали и меняли его без пропсов и ref. CX Codex +1 ★ 7 191звёзд репо js-batch-dom-css Правило js-batch-dom-css запрещает чередовать чтение геометрии DOM с записью стилей. Защищает код от синхронного reflow и просадок FPS при анимациях. CX Codex +1 ★ 7 191звёзд репо perf-astro Скилл perf-astro для Claude Code настраивает сборку Astro: встраивает критический CSS, минифицирует файлы, задаёт неблокирующую загрузку шрифтов и preload LCP-картинки. CX Codex +1 ★ 7 191звёзд репо tactical-ddd Скилл tactical-ddd находит анемичные доменные модели и переводит их в богатые сущности по правилам тактического DDD. Он проверяет инкапсуляцию и готовит пошаговый рефакторинг для Claude Code. CX Codex +1 ★ 7 191звёзд репо nx-workspace Скилл nx-workspace для работы с Nx-монорепозиторием из CLI: список проектов, полная конфигурация, поиск затронутых проектов и affected-команды в CI. CX Codex +1 ★ 7 191звёзд репо perf-web-optimization Скилл perf-web-optimization помогает оптимизировать загрузку веб-страниц: настраивает отложенную загрузку, сокращает размер бандла и выставляет кэш. Пригодится при медленной работе сайта или тяжёлом JS. CX Codex +1 ★ 7 191звёзд репо

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

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