Documentation templates and structure guidelines. README, API docs, code comments, and AI-friendly documentation.

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 2. API Documentation Structure Per Endpoint Template 3. Code Comment Guidelines JSDoc/TSDoc Template 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) 5. Architecture Decision Record (ADR) 6. AI Friendly Documentation (2025) llms.txt Template For AI crawlers and agents: 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. Limitations Use this skill only when the task clearly matches the scope described above. Do not treat the output as a substitute for environment specific validation, testing, or expert review. Stop and ask for clarification if required inputs, permissions, safety boundaries, or success criteria are missing.

documentation-templates