SuperAPI AI 工具集

soia-dev-doc-sync

写作与研究

查看项目

更新于 10-16 08:39

技能介绍

用途:把代码、schema、manifest、版本文件、发布记录等明确真源与 docs/、README、CHANGELOG、VERSION 等派生文档逐项对账,输出事实漂移 finding 并在授权范围内修复。触发场景包括发布、版本升级、架构或 API 变更后需要回填文档,多语言页面或 README、CHANGELOG、VERSION 可能处于不同事实切片,以及用户要求“doc sync”“文档对账”“检查 docs 是否漂移”。

主要能力:建立真源优先级表,默认顺序为可执行或机器可读事实(代码、schema、manifest、锁定版本、生成输出、测试结果)、明确维护的发布事实、已审阅设计决策记录、派生叙述;识别 status-drift、coverage-gap、version-drift、release-drift、structural-drift、bilingual-drift、historical-snapshot-gap、link-or-reference-drift 等漂移类型;每项 finding 记录真源与派生位置、摘录、预期、观察值与建议动作,区分推断与已验证事实;按依赖顺序修复,先解决真源冲突,再同步版本/发布事实、摘要页、README、导出页与翻译页。

使用方式:提供目标仓库、待检查文档范围及已知真源(如 manifest、版本文件、release note、API schema、测试或生成输出);真源优先级不明确时先确认,不以旧文档互相佐证。涉及覆盖、删除、发布或远端状态时先展示目标、影响与补丁预览并取得确认。安装命令保持原样:claude plugin marketplace add soia-team/soia-open-skills;claude plugin install soia-dev@soia。单技能可用 npx skills add soia-team/soia-open-dev-skills -g -a '*' -s soia-dev-doc-sync -y。

限制:强依赖目标仓库及真源文件的只读访问;缺少 lint、测试、生成器或链接检查器时需如实报告未覆盖的验证面;不将派生文档反向视为真源,不虚构发布状态或产品行为,不在未授权时发布、发送、覆盖远端文档或修改版本标签。WorkBuddy 需单独安装,详见 docs/install/workbuddy.md。普通单篇创作、纯翻译或无需事实对账的文案不触发本技能。