SuperAPI AI 工具集

Documentation System

写作与研究

查看项目

更新于 10-15 22:13

技能介绍

用途:Documentation System 是一套代码库文档标准,适用于编写文档、决定文档位置、审查文档质量,以及在代码变更后更新文档。其目标是让文档清晰、可维护,并便于人类与 AI 导航。

核心原则:记录逻辑而非语法,说明各部分如何协同,而非代码中显而易见的内容;渐进式披露,先给概览再按需展开细节;结构清晰以便 AI 找到并更新正确文档;最小但完整,只包含必要内容。

目录结构:文档位于 docs/,含三个顶层文件夹。docs/index.md 是入口,说明代码库是什么、如何导航;docs/system/ 说明系统如何工作,包括能力、概念与流程;docs/packages/ 存放各包文档;docs/guides/ 存放面向任务的 how-to。每个文件夹都有 index.md,含导航链接与描述。

参考文档:structure.md 用于创建新文档、重组或决定内容归属;content.md 用于撰写或审查内容与风格;maintenance.md 用于代码变更后检查文档是否需更新;templates/ 提供新文档的起始模板。

使用方式:创建新文档时,先确定类型(系统概念、包文档或指南),检查是否应扩展现有文档,使用 references/templates/ 中合适模板,并加入相关 index.md 导航。查找文档时从 docs/index.md 开始,系统级概念看 docs/system/,包细节看 docs/packages/[package-name].md,操作说明看 docs/guides/。代码变更后,找出引用该代码的文档,检查描述是否仍准确,更新文件路径等引用,删除内容前先检查交叉引用。

不应记录的内容:频繁变化的实现细节、命名良好的代码已显而易见的信息、可自动生成的内容(如 API 签名、类型定义)、推测性的未来计划(应使用项目跟踪工具)。

限制:资料未提供具体安装命令、平台支持、收费或价格信息,暂未提供。