← ClaudeAtlas

soia-dev-doc-synclisted

审计并修复任意代码仓的 docs、README、CHANGELOG、VERSION 与明确真源之间的事实漂移;先建立真源优先级与证据,再按依赖顺序同步派生文档。
soia-team/soia-open-skills · ★ 2 · AI & Automation · score 72
Install: claude install-skill soia-team/soia-open-skills
# soia-dev-doc-sync ## 客户可读说明 ### 这个技能可以做什么 把代码、版本元数据、发布记录等明确真源与 `docs/`、README、CHANGELOG、VERSION 等派生文档逐项对账,报告事实漂移并在授权范围内修复。 | 客户想要 | 技能会做 | 客户能看到 | |---|---|---| | 检查文档是否过时 | 建立真源清单,比较每个声明和对应证据 | finding、证据、严重度和建议修复顺序 | | 发布或重大改动后同步文档 | 先更新真源,再回填派生层 | 改动范围、验证结果与残余风险 | ### 客户如何使用 提供目标仓库、待检查的文档范围,以及已知的真源(例如 manifest、版本文件、release note、API schema、测试或生成输出)。若真源优先级不明确,先确认,不用旧文档互相佐证。 涉及覆盖、删除、发布或远端状态时,先展示目标、影响和补丁预览并取得确认。普通单篇创作、纯翻译或不需要事实对账的文案不触发本技能。 ### 依赖与安装 安装: ```bash npx skills add soia-team/soia-open-skills -g -a '*' -s soia-dev-doc-sync -y ``` 强依赖:目标仓库及其真源文件的只读访问。可选使用项目已有的 lint、测试、生成器或链接检查器;缺少时如实报告未覆盖的验证面。 本技能无需私有配置。用户特定路径只在本次参数或环境中提供,不写入技能。 ### 日志与完成回执 ```markdown 完成:<审计或同步的结果>。 真源与范围:<已核实的真源及派生文档范围> 发现:<类别、数量、证据摘要> 文件变化:<更新的文档类别;无改动则写“无”> 验证:<运行的检查及结果> 残余风险:<未验证真源、无法访问的输入或“无”> ``` ## 触发条件 - 发布、版本升级、架构或 API 变更后需要回填文档; - README、CHANGELOG、VERSION、架构说明或多语言页面可能处于不同事实时间切片; - 用户要求“doc sync”“文档对账”“检查 docs 是否漂移”。 ## 真源优先级 在开始前为本次任务写出真源表。推荐的默认顺序是: 1. 可执行或机器可读的事实:代码、schema、manifest、锁定版本、生成输出、测试结果; 2. 明确维护的发布事实:版本文件、签发的 release note、变更记录; 3. 已审阅的设计或决策记录; 4. README、指南、架构说明、导出页等派生叙述。 项目可以定义更高优先级的权威来源;遵守它。若两个同级真源冲突,停止自动回填,报告冲突的文件、字段和最小复核路径。绝不为了让文档一致而修改真源。 ## 漂移分类 - `status-drift`:生命周期或支持状态不一致; - `coverage-gap`:真源已有功能、版本或变更,派生文档漏记; - `version-drift`:版本号、发布日期或兼容范围不一致; - `release-drift`:release note、CHANGELOG 和版本时间线互相矛盾; - `structural-drift`:模块、命令、接口、配置项或数量仍是旧事实; - `bilingual-drift`:不同语言页面处于不同事实切片; - `historical-snapshot-gap`:历史快照没有标示其时点和当前真源; - `link-or-reference-drift`: