用途:为 AI 智能体提供常见文档类型的模板与结构规范,帮助生成或整理项目文档。
主要能力:
- README 结构:按优先级列出标题与一句话简介、快速开始、功能、配置、API 参考链接、贡献指南、许可证等章节,并给出 README 模板。
- API 文档结构:提供按端点编写的模板,包含参数表(名称、类型、是否必填、说明)、响应状态码与请求响应示例。
- 代码注释指南:给出 JSDoc/TSDoc 模板,含 @param、@returns、@throws、@example,并说明何时该注释(业务逻辑、复杂算法、非显而易见行为、API 契约)与何时不必注释。
- 变更日志模板:遵循 Keep a Changelog 风格,含 Unreleased、Added、Changed、Fixed 等条目。
- 架构决策记录(ADR):含状态、背景、决策、后果四部分。
- 面向 AI 的文档:提供 llms.txt 模板(项目名、一句话目标、核心文件、关键概念),以及面向 RAG 索引的 MCP 就绪文档建议,如清晰的 H1-H3 层级、JSON/YAML 数据结构示例、Mermaid 流程图、自包含章节。
- 结构原则:可扫读(标题、列表、表格)、示例优先、渐进式细节(由简到繁)、保持更新。
使用方式:作为可安装技能引入 AI 智能体后,按上述模板与结构生成或校对文档。资料未提供具体安装命令与调用步骤。
适用场景:编写项目 README、API 参考、代码注释、变更日志、架构决策记录,以及为 AI 爬虫与智能体准备文档。
限制:模板仅为起点,需按项目实际调整;资料未说明收费、价格、平台支持或效果保证。