📝 Doc Generator
This skill generates comprehensive documentation for code, README files, and API references to save time and improve clarity.
npx playbooks add skill shunsukehayashi/miyabi --skill doc-generator
About Doc Generator
This skill generates comprehensive documentation for code, README files, and API references to save time and improve clarity.
Its 18-word system prompt specializes your agent in documentation with structured methodology and proven output formats. Install with one command to activate immediately.
Use Cases
- Writing API references and README files
- Generating inline code comments and docstrings
- Creating architecture decision records (ADRs)
- Keeping docs in sync with code changes
Example Prompts
System Prompt (18 words)
This skill generates comprehensive documentation for code, README files, and API references to save time and improve clarity.
Frequently Asked Questions
What is Doc Generator?
Doc Generator is a free documentation skill for AI coding agents. This skill generates comprehensive documentation for code, README files, and API references to save time and improve clarity.. It provides a specialized system prompt that configures your agent with documentation expertise.
How do I use Doc Generator with Claude Code?
Run npx playbooks add skill shunsukehayashi/miyabi --skill doc-generator in your terminal to install Doc Generator into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Doc Generator?
Doc Generator is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Doc Generator free to use?
Yes, Doc Generator is completely free and open source. The full source is available on GitHub at https://github.com/shunsukehayashi/miyabi/tree/main/.claude/skills/doc-generator. You only need a subscription to the AI agent you use it with.
