documentation-templates

Documentation Templates — Technical Documentation Templates and Structural Standards

Skills Overview

Provide standard templates and structural guidelines for various technical documents, helping developers quickly write READMEs, API documentation, code comments, and AI-friendly documentation.

Applicable Scenarios

1. Open-Source Project Initialization

When creating a new project, directly use an existing README template to quickly set up the documentation framework, ensuring it includes essential sections such as Quick Start, Feature Highlights, Configuration Instructions, Contribution Guidelines, and more.

2. Writing API Interface Documentation

Generate a standard API documentation structure for REST APIs, consistently describing request parameters, response formats, status codes, and examples so the API documentation is clear and easy to read.

3. AI Index-Friendly Documentation

Write documentation according to the llms.txt and MCP-Ready specifications, enabling AI crawlers and RAG systems to correctly understand and index the project content.

Core Features

README Structural Template

Provide an industry-validated standard README structure, including key sections such as title, Quick Start, feature list, configuration instructions, and documentation links—along with complete Markdown template code.

API Documentation Standard

Provide a unified documentation template for each API endpoint, standardizing parameter tables, response descriptions, and example code to ensure consistency and readability across the API documentation.

Code Commenting Guidelines

Provide JSDoc/TSDoc standard commenting templates, clarifying when comments are needed and when they are not, helping teams establish consistent code-commenting practices.

Multi-Scenario Documentation Templates

Cover various documentation scenarios such as Changelog (change log), ADR (architecture decision records), llms.txt (AI-friendly documentation), and more—each template includes structural guidance and example code.

Frequently Asked Questions

What must a README include?

Core contents include the project title, a one-sentence description, Quick Start, a feature list, configuration instructions, documentation links, and the open-source license. Quick Start is especially important—it should enable users to run the project within 5 minutes.

What should code comments include?

Comments should explain the “why” (business-logic rationale), not the “what” (the code itself). Comment when scenarios are complex algorithms, non-obvious behavior, API contracts, etc. Do not comment every line of code or obvious/self-explanatory logic.

How do I make documentation more friendly to AI?

Use clear H1–H3 heading hierarchy, provide complete JSON/YAML examples, use Mermaid diagrams to show workflows, and keep each section self-contained. You can create an llms.txt file listing core file paths and explanations of key concepts.