SuperAPI AI 工具集

soia-dev-doc-sync

写作与研究

查看项目

更新于 10-16 08:49

技能介绍

用途:把代码、版本元数据、发布记录等明确真源与 docs/、README、CHANGELOG、VERSION 等派生文档逐项对账,报告事实漂移并在授权范围内修复。适用于发布、版本升级、架构或 API 变更后回填文档,或用户要求“doc sync”“文档对账”“检查 docs 是否漂移”。

主要能力:建立真源清单并比较每个声明与对应证据,输出 finding、证据、严重度和建议修复顺序;漂移分类包括 status-drift、coverage-gap、version-drift、release-drift、structural-drift、bilingual-drift、historical-snapshot-gap、link-or-reference-drift。每项 finding 记录真源位置与摘录、派生位置与摘录、预期、观察值和建议动作,并区分“推断”与“已验证事实”。

使用方式:提供目标仓库、待检查文档范围及已知真源(manifest、版本文件、release note、API schema、测试或生成输出)。真源优先级不明确时先确认,不用旧文档互相佐证。推荐默认顺序为:可执行或机器可读事实、明确维护的发布事实、已审阅的设计或决策记录、派生叙述。项目可定义更高优先级权威来源并遵守。涉及覆盖、删除、发布或远端状态时,先展示目标、影响和补丁预览并取得确认。

安装:npx skills add soia-team/soia-open-skills -g -a '*' -s soia-dev-doc-sync -y

限制:强依赖目标仓库及其真源文件的只读访问;可选使用项目已有 lint、测试、生成器或链接检查器,缺少时如实报告未覆盖的验证面。无需私有配置。普通单篇创作、纯翻译或不需要事实对账的文案不触发本技能。不将派生文档反向视为真源,不虚构发布状态、测试结论、支持承诺或未验证行为,不在未授权时发布、发送、覆盖远端文档或修改版本标签,不把本机路径、账号、密钥、私有 workspace 或组织内部流程写入可复用文档。同级真源冲突时停止自动回填并报告冲突。