SuperAPI AI 工具集

update-docs

写作与研究

查看项目

更新于 10-16 08:05

技能介绍

用途:在当前分支上根据源码改动更新文档页面。该技能分析相对 main 的 diff,将改动的源文件映射到对应文档页,并做定向编辑。

主要能力:读取当前分支名并据此在文档仓库创建同名分支(如源分支 feat/new-service 对应 feat/new-service-docs);通过 git rev-parse --abbrev-ref HEAD 与 git diff main..HEAD --name-only 检测改动;按 profile(.claude/skills/update-docs/SOURCE_DOC_MAPPING.md)中的跳过表、基类表、非标准位置表、模式表逐级解析文档页,必要时用 grep 搜索;逐对分析源码与文档,比对构造函数参数、选项字段、事件处理器、类名与导入、行为变化、命令行参数等;只编辑需要改动的部分,保持原有格式与内容;检查并更新引用改动 API 的指南;识别缺失页面与缺失小节;新增页面按 profile 模板创建并完成全部注册步骤;最后格式化并重新生成 llms.txt 与 llms-full.txt。

用法:/update-docs [DOCS_PATH],DOCS_PATH 为可选文档仓库根路径,未提供时向用户询问。文档路径需存在且包含 docs.json。若缺少 profile 则停止。后续在文档分支上执行编辑,并在结尾输出更新摘要。

限制:技能与仓库无关、保持共享,不硬编码源路径、页面模板或导航分组,具体内容全部来自被文档化的仓库 profile;不提交或推送;不查看其他分支;仅在资料所述范围内编辑,不编造功能。