📝 Documentation Guidelines
Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding
npx playbooks add skill thienanblog/awesome-ai-agent-skills --skill documentation-guidelines
About Documentation Guidelines
Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding
At 39 words, this compact prompt gives your agent specialized documentation expertise with structured patterns and output formats. Install via CLI or copy the prompt below.
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 (39 words)
Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding
Frequently Asked Questions
What is Documentation Guidelines?
Documentation Guidelines is a free documentation skill for AI coding agents. Write or update backend feature documentation that follows a repo's DOCUMENTATION_GUIDELINES.md (or equivalent) across any project. Use when asked to create/update module docs, API contracts, or backend documentation that must include architecture, endpoints, payloads, Mermaid diagrams, and seeding . It provides a specialized system prompt that configures your agent with documentation expertise.
How do I use Documentation Guidelines with Claude Code?
Run npx playbooks add skill thienanblog/awesome-ai-agent-skills --skill documentation-guidelines in your terminal to install Documentation Guidelines into your Claude Code session. It works immediately after installation.
Which AI coding agents work with Documentation Guidelines?
Documentation Guidelines is compatible with Claude Code, Cursor, GitHub Copilot, Windsurf, OpenClaw, Cline, and any AI agent that supports custom system prompts or .cursorrules files.
Is Documentation Guidelines free to use?
Yes, Documentation Guidelines is completely free and open source. The full source is available on GitHub at https://github.com/thienanblog/awesome-ai-agent-skills/tree/main/skills/documentation-guidelines. You only need a subscription to the AI agent you use it with.
