# skill-documenter-agent

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.

- subagent · `type=agent` · Claude Code, Codex, Cursor · ★ 1357 repo stars
- Author: qdhenry
- License: not stated · policy=link-only · description only; the file stays with the author
- Source: https://github.com/qdhenry/Claude-Command-Suite/tree/HEAD/.claude/agents/skill-builder/skill-documenter-agent.md
- Updated: 2026-03-01
- Security check: automated, 2026-11-16 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/agents/skill-documenter-agent

## What it 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.

## Install

### Claude Code (native platform)

**Manually: put the files in place**
- File: `.claude/agents/skill-documenter-agent.md` — For all projects use ~/.claude/agents/. Claude delegates by the description field or an @-mention

### Codex

**Manually: put the files in place**
- File: `.codex/agents/skill-documenter-agent.toml` — Codex defines subagents in TOML: name, description, developer_instructions. Move the Markdown text into developer_instructions by hand. For all projects use ~/.codex/agents/

### Cursor

**Manually: put the files in place**
- File: `.cursor/agents/skill-documenter-agent.md` — Cursor also reads .claude/agents/

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/qdhenry/Claude-Command-Suite/tree/HEAD/.claude/agents/skill-builder/skill-documenter-agent.md

## When to use it
- 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
- 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

## Similar
- [codebase-documenter](https://affpapa.org/en/nevibecode/skills/travisjneuman-codebase-documenter.md) — skill · 145 installs
- [code-documenter](https://affpapa.org/en/nevibecode/skills/code-documenter.md) — skill · 6200 installs
- [design-system-documenter](https://affpapa.org/en/nevibecode/skills/design-system-documenter.md) — skill · 165 installs
- [Project Documenter](https://affpapa.org/en/nevibecode/agents/project-documenter.md) — subagent · ★ 41430 repo stars
- [api-documenter](https://affpapa.org/en/nevibecode/agents/voltagent-api-documenter.md) — subagent · ★ 6505 repo stars
- [swift-documenter](https://affpapa.org/en/nevibecode/agents/swift-documenter.md) — subagent · ★ 233 repo stars

From the same set: [qdhenry/claude-command-suite](https://affpapa.org/en/nevibecode/by/qdhenry/claude-command-suite.md) — 112 cards

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
