SuperAPI AI 工具集

refresh-docs

编程与开发

查看项目

更新于 10-15 23:42

技能介绍

用途:在已存在反向工程文档的前提下,根据自上次生成以来的 git 提交增量更新文档,避免全量重生成。适用于代码已变化、希望保持文档同步且在意时间成本的场景。

主要能力:从 docs/reverse-engineering/.stackshift-docs-meta.json 读取固定的 commit_hash,运行 git diff 对比该哈希与 HEAD;按变更文件类型将其映射到受影响文档(如 src/api/** 影响功能规格、集成点、数据架构;src/models/** 影响数据架构;tests/** 影响测试文档);仅分析变更代码并以外科手术式编辑更新相关章节;随后更新元数据中的提交哈希,记录 refresh_history,并更新文档头部时间戳,最后输出新增/修改/删除的摘要。

使用方式:触发语包括“更新反向工程文档”“刷新文档”“同步文档与最新代码”等。前置条件为已存在反向工程文档及 .stackshift-docs-meta.json。若文档已是最新则直接提示无需刷新。当变更规模过大(如超过 60% 源文件变化、主版本升级、框架迁移)时可选择全量刷新,即改用 /stackshift.reverse-engineer 重新生成全部文档。

限制:需要 git 仓库且指定的固定提交仍存在,否则无法做增量更新(提交被 rebase 或 force-push 移除时需回退到全量刷新)。若只有文档而缺少元数据文件,需重新生成或在当前 HEAD 创建元数据。合并提交带来的差异会以净效果方式处理。未提供具体收费、价格或平台支持信息。