SuperAPI AI 工具集

wiki-update

写作与研究

查看项目

更新于 10-23 16:16

技能介绍

用途

wiki-update 用于在仓库源码发生变化后,刷新已有的 openwiki/ 文档,使其保持准确。其核心原则是“外科手术式”更新:只改动因源码变更而过时的内容,而非每次全量重写文档。

主要能力

  • 空操作检查:若自上次更新以来仓库没有变化,则跳过整个运行,报告未检测到变更并停止编辑。
  • 收集 git 证据:运行 git status --short、git rev-parse HEAD、git diff --name-status HEAD,并查看上次成功运行以来的提交(优先 git log <lastGitHead>..HEAD --name-status --oneline),对高信号提交使用 git show 理解实际改动。
  • 制定文档影响计划:按“源码变更 → 受影响文档 → 所需编辑 → 原因”梳理,编辑前先阅读受影响的 openwiki/ 页面。
  • 精准编辑:保留仍然准确的现有结构与措辞,优先替换单句过时内容而非新增段落;只编辑因近期变更而不准确、不完整或误导的页面;每个概念保留在单一权威页面,其他提及保持简短或仅链接;不做纯格式调整;不随意更新 Source Map、git 证据列表或泛泛的“注意事项”章节;不保留或刷新常驻提交哈希列表,除非某提交解释了重要历史决策。
  • 软性差异预算:若变更源码文件少于约 5 个,最多更新 1–2 个 wiki 页面;避免改动 quickstart,除非顶层产品行为、安装设置或导航发生变化;若认为需要编辑超过 3 个 wiki 页面,应先深入思考原因。
  • 允许空操作:若 wiki 已经准确,则不编辑文件并说明文档已是最新。
  • 检查根级 agent 指令文件:检查顶层 AGENTS.md/CLAUDE.md 中的 OpenWiki 引用段落,仅在缺失或语义过时时刷新(模板见 core.md),即使 wiki 本身已最新也须执行此检查。
  • 记录运行元数据:仅在确实修改了 openwiki/ 内容时,按 core.md 的格式重写 openwiki/.last-update.json,并写入 "command": "update"。

使用方式

调用本技能后,先阅读其目录下的 references/core.md,其中定义了所有输出必须遵循的质量规则、结构要求、安全规则以及 AGENTS.md/CLAUDE.md 引用模板。若 openwiki/quickstart.md 不存在,应停止并提示用户先运行 /wiki-init。若用户在调用时附带了额外指令,则跳过空操作检查,以用户指令作为更新驱动。完成编辑后,汇总哪些页面发生了变更及其原因,或说明 wiki 已是最新。

适用场景

适用于已通过 OpenWiki 初始化并维护 openwiki/ 文档的代码仓库,在提交源码改动后需要让文档与代码保持一致时使用。

限制

依赖 git 历史与工作区状态作为证据;空操作检查依赖 openwiki/.last-update.json 中记录的 gitHead 等元数据。文档未提供具体的命令行安装方式、价格或平台信息。