SuperAPI AI 工具集

docs

通用与其它

查看项目

更新于 10-15 22:34

技能介绍

用途:保持仓库文档对智能体与人类都易读。它聚焦仓库自有、与决策相关的真实信息,按每 token 价值优化文档。

主要能力:审计 AGENTS.md、CLAUDE.md、README.md、CONTRIBUTING.md、SECURITY.md、docs/ 及持久规格、运行手册、决策文档;标记过期命令、失效路径、重复指引、路由失败、叙事式历史、穷举式负面清单,以及仓库内部细节泄漏到读者面文档的问题;更新路由型文档与深度文档、规格;清理漂移;用检查命令验证内容与仓库一致。

原则:代码变更都可能伴随文档变更;只描述当前状态,历史仅保留于迁移说明、变更日志与决策;先写受支持的能力与下一步操作;偏好简短、面向任务的章节与结构化事实;路由文档保持简短并指向更深文档;仓库内文档使用仓库相对链接。

改写当前状态文档时适用负状态规则:删除所有不存在、已移除或未配置的条目,包括具体名称与类别改写,除非它会影响当前可信操作;必须保留的限制只能写一条精确边界与受支持路径。

使用流程:1) 审计文档面,编辑前先分类目标为仓库文档、智能体指引或持久规格/决策,识别每节支持的决策或任务,保留命令、路径、不变量、边界与恢复步骤;2) 更新路由型文档,AGENTS.md 应作为紧凑操作契约与地图,若仓库使用 AGENTS.md,CLAUDE.md 应改为符号链接或 @AGENTS.md 导入;3) 更新深度文档与规格;4) 清理漂移;5) 验证现实,例如用 rg -n 检查旧路径或命令、用 test -e 验证文档引用的路径、规范化入口时检查 CLAUDE.md 是否为指向 AGENTS.md 的链接。

边界:不处理战术工作规划、史诗或跟踪器工单创建、启动与就绪配置、基础 PR/议题/贡献者/安全策略模板、独立代码审查、运行时验证。

输出:完成后给出紧凑文档页脚,最多五行,报告更新的文件、已验证的命令名或路径检查、移除或重写的内容(仅当涉及过期或重复文档)、遗留文档缺口,以及下一步。

具体安装命令、收费与平台信息暂未提供。