SuperAPI AI 工具集

update-docs

智能体与模型

查看项目

更新于 10-15 20:30

技能介绍

用途:将 docs 目录及 AGENTS.md 等文档更新为与当前代码库一致,适用于用户要求更新文档、刷新文档或同步文档与代码的场景。

主要能力:先做 Oracle 前置分析,清点每份高价值文档中的独特知识、历史背景与必须保留的内容,形成保留清单;随后发现文档(含 tag 为 plan 的工单、/AGENTS.md、docs//* 等),逐份对照代码校验是否误导、过时、错误、缺失或冗余;检查是否符合 AGENTS.md 的命名、架构与代码风格要求;对 plan 文档做实现状态审计并分类 open、closed、obsolete;跨文档做术语一致性、覆盖缺口与链接校验;最后输出更新摘要,并以 todos_oneshot 保存为 docs 标签的工单,并做构建、链接、完整性与保留性检查。

必要用法:修改重要文档前必须先用 teams(action: 'delegate', tasks: [...]) 委派 doc-oracle 分析;plan 状态用 tk list --tag plan 查询,进度用 tk add-note <id> "<progress>" 记录,确认完成用 tk close <id>;仅当全部条目经代码审计确认为已实现时才能关闭。

适用场景:AGENTS.md、架构文档、决策记录、入职指南,以及超过 200 行或超过 30 天未更新的文档;对为什么、历史、决策、坑点、警告等章节尤其适用。

限制:无显式批准不得删除架构决策及其理由、警告与不要这样做的指引、迁移说明和非显然约定;跳过 Oracle 仅限拼写、新增章节、版本日期、已知有效链接等少数情况;文档中对精确命令、路径与图表的细节以实际资料为准,本说明未提供收费、价格与平台信息。