skill-documenter-agent — Claude Code subagent for skill documentation
skill-documenter-agent — a subagent that writes complete documentation for Claude Code skills: SKILL.md, examples, API reference, and usage guides. Works directly with code and text.
no license ★ 1,357 updated 2026-03-01
.claude/agents/skill-documenter-agent.mdWhat skill-documenter-agent does
This subagent automates skill documentation creation. It understands SKILL.md structure, writes instruction sections with examples and best practices, and generates reference files. Equipped with Read, Write, Edit, Grep, Glob, and WebFetch tools—can read skill source code, create new documentation files, and verify completeness.
The workflow follows three phases: first, the subagent analyzes the skill's purpose and target users; then it creates SKILL.md with quick start and step-by-step instructions; finally, it adds usage examples, best practices, and troubleshooting sections. For complex skills, it generates separate reference.md with API documentation and advanced patterns.
Use this when building a new skill or rewriting existing documentation—manual work takes hours.
What it helps with
- write SKILL.md for a new skill with clear instructions and examples
- generate API reference and usage examples for a skill
- add best practices and troubleshooting sections to skill docs
- restructure and improve existing skill documentation
- create README for a skill with quick start and requirements
Example prompts for the agent
- Document my new skill for Claude Code: analyze the code and write a complete SKILL.md
- Create an API reference guide and usage examples for my file processing skill
- Rewrite skill docs: add best practices, common errors, and how to fix them
How to install skill-documenter-agent
Manually: put the files in place
.claude/agents/skill-documenter-agent.mdFor all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention
Manually: put the files in place
.codex/agents/skill-documenter-agent.tomlCodex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/
Manually: put the files in place
.cursor/agents/skill-documenter-agent.mdCursor also reads .claude/agents/
Step by step, with commands for each platform: Claude Code subagents: how to create one, call it and keep context clean
Questions about skill-documenter-agent
How do I install skill-documenter-agent in Claude Code?
Place the file in your agents directory: put skill-documenter-agent.md in .claude/agents/. For Codex, use .codex/agents/skill-documenter-agent.toml; for Cursor, use .cursor/agents/skill-documenter-agent.md.
What does skill-documenter-agent do?
It generates professional documentation for Claude Code skills: structures SKILL.md with instructions and examples, creates API reference guides, adds best practices and troubleshooting. Analyzes code, dependencies, and requirements.
What output does the subagent produce?
Ready-to-use SKILL.md with quick start and step-by-step guidance, usage examples for different scenarios, API reference documentation, best practices, and troubleshooting sections. You can use it immediately or refine as needed.