Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Add this skill
npx mdskills install sickn33/documentation-templatesComprehensive reference with clear templates for READMEs, APIs, comments, and modern AI-friendly docs
Templates and structure guidelines for common documentation types.
| Section | Purpose |
|---|---|
| Title + One-liner | What is this? |
| Quick Start | Running in One-line objective. |
### MCP-Ready Documentation
For RAG indexing:
- Clear H1-H3 hierarchy
- JSON/YAML examples for data structures
- Mermaid diagrams for flows
- Self-contained sections
---
## 7. Structure Principles
| Principle | Why |
|-----------|-----|
| **Scannable** | Headers, lists, tables |
| **Examples first** | Show, don't just tell |
| **Progressive detail** | Simple → Complex |
| **Up to date** | Outdated = misleading |
---
> **Remember:** Templates are starting points. Adapt to your project's needs.
Install via CLI
npx mdskills install sickn33/documentation-templatesDocumentation Templates is a free, open-source AI agent skill. Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
Install Documentation Templates with a single command:
npx mdskills install sickn33/documentation-templatesThis downloads the skill files into your project and your AI agent picks them up automatically.
Documentation Templates works with Claude Code, Claude Desktop, Cursor, Vscode Copilot, Windsurf, Continue Dev, Codex, Gemini Cli, Amp, Roo Code, Goose, Opencode, Trae, Qodo, Command Code. Skills use the open SKILL.md format which is compatible with any AI coding agent that reads markdown instructions.