documentation-templates

Standardized templates and guidelines for READMEs, API docs, code comments, and AI-friendly documentation. Templates and structure guidelines for common documentation types. For AI crawlers and agents: For RAG indexing: Remember: Templates are starting points. Adapt to your project's needs. This skill is applicable to execute the workflow or actions described in the overview. - Includes structured templates for README files, per-endpoint API documentation, JSDoc/TSDoc comments, and changelog formats - Provides Architecture Decision Record (ADR) template for documenting design choices and trade-offs - Covers AI-friendly documentation patterns including llms.txt format and MCP-ready documentation with clear hierarchy, examples, and diagrams - Emphasizes scannable structure, progressive detail levels, and practical guidance on when and what to document - Clear H1-H3 hierarchy - JSON/YAML examples for data structures - Mermaid diagrams for flows - Self-contained sections - 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.