用途:为项目提供常见文档类型的模板和结构规范,帮助统一 README、API 文档与代码注释的写法。
主要能力与内容:
- README 结构,按优先级给出标题与一句话简介、快速开始、功能、配置、API 参考链接、贡献指南、许可证等章节,并附 README 模板。
- API 文档结构,给出按端点(如 GET /users/:id)的模板,包含参数表、响应状态码和请求响应示例。
- 代码注释指南,提供 JSDoc/TSDoc 模板,并说明何时该注释(业务原因、复杂算法、非显而易见行为、API 契约)与何时不该注释(显而易见的内容、逐行注释、实现细节)。
- 变更日志模板(Keep a Changelog),包含 Unreleased、Added、Changed、Fixed 等条目。
- 架构决策记录(ADR)模板,含状态、背景、决策与后果。
- AI 友好文档(2025):llms.txt 模板,供 AI 爬虫与智能体使用;以及面向 RAG 索引的 MCP 就绪文档建议,如清晰的 H1-H3 层级、数据结构用 JSON/YAML 示例、流程用 Mermaid 图、章节自包含。
- 结构原则:可扫读(标题、列表、表格)、示例优先、逐步展开细节(由简到繁)、保持更新。
使用方式:将模板作为起点,按项目需求调整;详细步骤与完整示例未提供。
限制:资料未提供安装方式、价格、平台或具体工具依赖。