Documentation Templates
Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.
mkdir -p ./skills/documentation-templates && curl -sfL https://raw.githubusercontent.com/mayurrathi/awesome-agent-skills/main/skills/documentation-templates/SKILL.md -o ./skills/documentation-templates/SKILL.mdRun in terminal / PowerShell. Requires curl (Unix) or PowerShell 5+ (Windows).
Skill Content
# Documentation Templates
> Templates and structure guidelines for common documentation types.
---
1. README Structure
Essential Sections (Priority Order)
| Section | Purpose |
|---------|---------|
| **Title + One-liner** | What is this? |
| **Quick Start** | Running in <5 min |
| **Features** | What can I do? |
| **Configuration** | How to customize |
| **API Reference** | Link to detailed docs |
| **Contributing** | How to help |
| **License** | Legal |
README Template
```markdown
# Project Name
Brief one-line description.
Quick Start
[Minimum steps to run]
Features
- Feature 1
- Feature 2
Configuration
| Variable | Description | Default |
|----------|-------------|---------|
| PORT | Server port | 3000 |
Documentation
- API Reference
- Architecture
License
MIT
```
---
2. API Documentation Structure
Per-Endpoint Template
```markdown
GET /users/:id
Get a user by ID.
**Parameters:**
| Name | Type | Required | Description |
|------|------|----------|-------------|
| id | string | Yes | User ID |
**Response:**
- 200: User object
- 404: User not found
**Example:**
[Request and response example]
```
---
3. Code Comment Guidelines
JSDoc/TSDoc Template
```typescript
/**
* Brief description of what the function does.
*
* @param paramName - Description of parameter
* @returns Description of return value
* @throws ErrorType - When this error occurs
*
* @example
* const result = functionName(input);
*/
```
When to Comment
| ✅ Comment | ❌ Don't Comment |
|-----------|-----------------|
| Why (business logic) | What (obvious) |
| Complex algorithms | Every line |
| Non-obvious behavior | Self-explanatory code |
| API contracts | Implementation details |
---
4. Changelog Template (Keep a Changelog)
```markdown
# Changelog
[Unreleased]
Added
- New feature
[1.0.0] - 2025-01-01
Added
- Initial release
Changed
- Updated dependency
Fixed
- Bug fix
```
---
5. Architecture Decision Record (ADR)
```markdown
# ADR-001: [Title]
Status
Accepted / Deprecated / Superseded
Context
Why are we making this decision?
Decision
What did we decide?
Consequences
What are the trade-offs?
```
---
6. AI-Friendly Documentation (2025)
llms.txt Template
For AI crawlers and agents:
```markdown
# Project Name
> One-line objective.
Core Files
- [src/index.ts]: Main entry
- [src/api/]: API routes
- [docs/]: Documentation
Key Concepts
- Concept 1: Brief explanation
- Concept 2: Brief explanation
```
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.
When to Use
This skill is applicable to execute the workflow or actions described in the overview.
🎯 Best For
- Technical writers
- API documentation teams
- UI designers
- Product designers
- Claude users
💡 Use Cases
- Generating JSDoc/TSDoc comments
- Writing README files for new projects
- Generating component mockups
- Creating design system tokens
📖 How to Use This Skill
- 1
Install the Skill
Copy the install command from the Terminal tab and run it. The SKILL.md file downloads to your local skills directory.
- 2
Load into Your AI Assistant
Open Claude and reference the skill. Paste the SKILL.md content or use the system prompt tab.
- 3
Apply Documentation Templates to Your Work
Open your project in the AI assistant and ask it to apply the skill. Start with a small module to verify the output quality.
- 4
Review and Refine
Review AI suggestions before committing. Run tests, check for regressions, and iterate on the skill output.
❓ Frequently Asked Questions
Does it follow my documentation style?
Most documentation skills respect existing style. Provide a style guide or example in your prompt.
Does this work with Figma?
Some design skills integrate with Figma plugins. Check the Works With section for supported tools.
Is Documentation Templates compatible with Cursor and VS Code?
Yes — this skill works with any AI coding assistant including Cursor, VS Code with Copilot, and JetBrains IDEs.
Do I need specific dependencies for Documentation Templates?
Check the install command and Works With section. Most code skills only require the AI assistant and your codebase.
How do I install Documentation Templates?
Copy the install command from the Terminal tab and run it. The skill downloads to ./skills/documentation-templates/SKILL.md, ready to use.
⚠️ Common Mistakes to Avoid
Auto-generating without reviewing
AI documentation can contain inaccuracies. Always verify technical accuracy.
Skipping usability testing
AI-generated designs should be validated with real users before development.
Skipping validation
Always test AI-generated code changes, even for simple refactors.
Missing dependency updates
Check if the skill requires updated dependencies or new packages.