用途:为常见文档类型提供可复用的模板与结构规范,帮助项目快速组织 README、API 文档、代码注释、变更日志和架构决策记录,并顺应 2025 年面向 AI 爬虫与智能体的文档需求。
主要能力与模板:
- README 结构:按优先级列出标题与一句话简介、快速开始(5 分钟内可运行)、功能、配置、API 参考链接、贡献指南、许可证。模板含项目名、简述、Quick Start、Features、配置表格(Variable/Description/Default,如 PORT 默认 3000)、文档链接与 License。
- API 文档结构:按端点编写,示例为 GET /users/:id,含描述、参数表(Name/Type/Required/Description)、响应(200 用户对象、404 未找到)与请求响应示例。
- 代码注释指南:给出 JSDoc/TSDoc 模板,包括描述、@param、@returns、@throws、@example。何时注释:业务逻辑原因、复杂算法、非显然行为、API 契约;何时不注释:显而易见的内容、逐行注释、自解释代码、实现细节。
- 变更日志模板:采用 Keep a Changelog 风格,含 Unreleased、版本号与日期,分类 Added/Changed/Fixed。
- 架构决策记录(ADR):含标题、状态(Accepted/Deprecated/Superseded)、Context、Decision、Consequences。
- 面向 AI 的文档:llms.txt 模板包含项目名、一句话目标、核心文件(如 src/index.ts、src/api/、docs/)与关键概念;MCP 就绪文档面向 RAG 索引,要求清晰的 H1-H3 层级、JSON/YAML 数据结构示例、Mermaid 流程图、自包含章节。
- 结构原则:可扫描(标题、列表、表格)、示例优先、由简到繁、保持最新,避免过时信息误导。
使用方式:将对应模板作为起点,按项目需要调整;资料未提供具体安装命令、脚本或价格信息。
适用场景:需要统一文档风格的开源或内部项目、API 服务、需要被 AI 工具检索理解的代码库。
限制:模板是起点而非固定标准,需自行适配;资料未说明工具化集成、自动化校验或收费情况。