用途:为常见文档类型提供模板与结构规范,帮助项目写出清晰、可扫描、便于维护的文档,并兼顾 AI 爬虫与智能体的读取需求。
主要能力:
- README 结构:按优先级给出标题与一句话简介、快速开始(5 分钟内可运行)、功能、配置、API 参考链接、贡献指南、许可证等章节,并附 README 模板。
- API 文档:按端点给出模板,包含方法路径、说明、参数表(名称/类型/是否必填/描述)、响应状态码与请求响应示例。
- 代码注释:提供 JSDoc/TSDoc 模板,含 @param、@returns、@throws、@example;并给出何时注释的对照(注释业务原因、复杂算法、非显而易见行为、API 契约;不注释显而易见的内容与实现细节)。
- 变更日志:采用 Keep a Changelog 风格,含 Unreleased 与版本号、日期,以及 Added/Changed/Fixed 分类。
- 架构决策记录(ADR):含标题、状态(Accepted/Deprecated/Superseded)、背景、决策、后果。
- AI 友好文档:给出 llms.txt 模板(项目名、一句话目标、核心文件、关键概念),以及面向 RAG 索引的 MCP 就绪文档建议:清晰的 H1-H3 层级、JSON/YAML 数据结构示例、Mermaid 流程图、自包含章节。
- 结构原则:可扫描(标题、列表、表格)、示例优先、渐进式细节(由简到繁)、保持最新。
使用方式:将各模板作为起点,按项目需要调整;README 按优先级顺序组织章节,API 文档逐端点套用模板,注释遵循 JSDoc/TSDoc 格式,变更日志与 ADR 按给定结构记录。
适用场景:开源或内部项目的文档搭建、API 说明编写、代码注释规范制定、版本发布记录、架构决策留档,以及为 AI 工具准备可索引文档。
限制:资料仅提供模板与结构建议,未说明具体工具、平台、收费或自动化能力;模板需按项目实际调整,缺失事实暂未提供。