docs-writer — скилл для Claude Code: что делает и как установить
Скилл docs-writer для Claude Code пишет, редактирует и проверяет документацию в проекте. Работает с README, Markdown-файлами и страницами docs/.
MIT ★ 7 191 обновлён 2026-10-24
npx skills add tech-leads-club/agent-skills --skill docs-writer -a claude-codeЧто делает 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-code2Вручную: положить файлы
~/.claude/skills/docs-writer/SKILL.mdПапка скилла целиком; для одного проекта — .claude/skills/docs-writer/
1Через Skills CLI (Vercel)
npx skills add tech-leads-club/agent-skills --skill docs-writer -a codex2Вручную: положить файлы
.agents/skills/docs-writer/SKILL.mdДля всех проектов — ~/.agents/skills/
1Через Skills CLI (Vercel)
npx skills add tech-leads-club/agent-skills --skill docs-writer -a cursor2Вручную: положить файлы
.cursor/skills/docs-writer/SKILL.mdCursor читает и .agents/skills/, и .claude/skills/
1GitHub CLI
gh skill install tech-leads-club/agent-skills 'packages/skills-catalog/skills/(development)/docs-writer'2Вручную: положить файлы
.github/skills/docs-writer/SKILL.md1Через Skills CLI (Vercel)
npx skills add tech-leads-club/agent-skills --skill docs-writer -a gemini-cli2Командой платформы
gemini skills install https://github.com/tech-leads-club/agent-skills --path 'packages/skills-catalog/skills/(development)/docs-writer'Вручную: положить файлы
.devin/skills/docs-writer/SKILL.mdСтарый путь .windsurf/skills/ тоже читается
Claude.ai
Упакуйте папку в zip и загрузите в Settings → Capabilities → Skills
По шагам, с командами для каждой платформы: Как установить скилл в 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