Generate Standardized Documentation Templates

Provides structure guidelines and templates for seven common documentation types. README structure prioritizes sections in order: title plus one-liner, a Quick Start runnable in under 5 minutes, Features, Configuration, an API Reference link, Contributing, and License.

# Project Name

Brief one-line description.

[Minimum steps to run]

• Feature 1
• Feature 2

• API Reference
• Architecture

MIT

The README's seven essential sections each answer a specific question: title plus one-liner asks "what is this?", Quick Start asks "how do I run it in under 5 minutes?", Features asks "what can I do?", Configuration asks "how do I customize it?", API Reference links to detail, Contributing explains how to help, and License covers the legal basics. API documentation follows a per-endpoint template (shown for `GET /users/:id`) with a parameters table (name, type, required, description), response status codes (for example 200 for the user object, 404 for not found), and a request/response example. Code comment guidance gives a JSDoc/TSDoc template (`@param`, `@returns`, `@throws`, `@example`) and a when-to-comment table: comment why (business logic), complex algorithms, non-obvious behavior, and API contracts; don't comment what's obvious, every line, self-explanatory code, or implementation details. The changelog template follows Keep a Changelog format with Unreleased/version sections split into Added/Changed/Fixed. The Architecture Decision Record template has Status (Accepted/Deprecated/Superseded), Context, Decision, and Consequences sections.

A 2025 AI-friendly documentation section covers an `llms.txt` template for AI crawlers and agents (one-line objective, a Core Files list, a Key Concepts list) and MCP-ready documentation guidance for RAG indexing: a clear H1-H3 hierarchy, JSON/YAML examples for data structures, Mermaid diagrams for flows, and self-contained sections. Four structure principles apply across all templates: scannable (headers, lists, tables), examples first (show, don't just tell), progressive detail (simple to complex), and kept up to date, since outdated documentation is misleading. The skill's own framing note: templates are starting points to adapt to a project's needs, not fill-in-the-blank forms.

Use it when writing or restructuring a README, API reference, code comments, changelog, architecture decision record, or AI-crawler-facing documentation (llms.txt) and need a proven section order rather than starting from a blank page.

Produces ready-to-fill Markdown/TypeScript templates for each documentation type listed above, each paired with a short table or checklist (README's priority-ordered sections, the when-to-comment table, the four structure principles) explaining why that structure was chosen.

Developers and technical writers who need a consistent starting structure across README files, API docs, code comments, changelogs, ADRs, and AI-crawler-facing documentation rather than reinventing section order project by project.