SuperAPI AI 工具集

sc-readme

通用与其它

查看项目

更新于 10-16 01:10

技能介绍

用途:sc-readme 是 SuperClaude 的文档自动维护技能,通过分析 git 变更来更新项目文档,并提供交叉引用校验与陈旧度报告。

主要能力:支持单文件 README 更新或全项目多文档更新;可按分支差异或最近 N 次提交分析;能识别 API、依赖、配置、功能、数据库、前端、基础设施等变更类别并映射到受影响文档;默认启用交叉引用校验(如 API 路由、环境变量、文件路径、组件名、命令语法的一致性);可生成陈旧度报告;对关键更新可强制使用 PAL 多模型共识,并用 PAL codereview 复核最终文档。

使用方式:常用命令包括 /sc:readme(按当前分支变更更新 README)、/sc:readme --scope all(多文档审查更新)、/sc:readme --scope api-docs(指定文档)、/sc:readme --preview(预览不写入)、/sc:readme --commits 20(分析最近提交)、/sc:readme --consensus(强制共识)、/sc:readme --base develop(指定基线分支)、/sc:readme --report-only(仅报告)。其他标志有 --cross-ref(默认 true)。

适用场景:需要让 README、API 文档、数据库文档、前端文档等随代码变更保持同步的仓库;提交前检查文档陈旧情况。

限制:仅修改文档范围内的 .md 文件;修改前备份文档,未经用户确认不移除章节;破坏性变更需共识;按 README 优先、依赖文档在后的顺序处理;可通过 git checkout 回滚。具体模型、价格与平台支持暂未提供。