documentation-templates

原文涵盖的主题

• Documentation Templates
• 1. README Structure
• Essential Sections (Priority Order)
• README Template
• 2. API Documentation Structure
• Per-Endpoint Template
• 3. Code Comment Guidelines
• JSDoc/TSDoc Template

Templates and structure guidelines for common documentation types. -- | 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 | -- -- | ✅ Comment | ❌ Don't Comment | |-----------|-----------------| | Why (business logic) | What (obvious) | | Complex algorithms | Every line | | Non-obvious behavior | Self-explanatory code | | API contracts | Implementation details | -- -- -- For AI crawlers and agents: For RAG indexing: Clear H1-H3 hierarchy JSON/YAML examples for data structures Mermaid diagrams for flows Self-contained sections -- | 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.