文档同步

📌 Skill 基础信息

• Skill 名称：docs-sync
• 简称：文档同步
• 来源：社区第三方（reblocke 开发）
• 运行宿主：Claude-Code CLI
• 核心定位：自动检测代码变更并同步更新相关文档，确保文档与代码行为保持一致，适用于需要维护高质量文档的代码仓库。

🧩 内部核心组成

该 Skill 主要通过规则约束和文档检查机制实现功能：

核心组件：

• 文档检查规则：自动扫描 README.md、docs/DECISIONS.md、docs/ 目录下的相关文档以及所有 ADR（架构决策记录）
• 变更同步机制：在代码变更时触发文档更新检查
• 决策记录规范：要求将持久性决策记录在指定文档中

约束规则：

• 代码行为变更时必须同步更新文档
• 公共接口、命令、假设或验证证据变化时需要更新文档
• 保持文档简洁和可操作：记录变更内容、原因、运行方式和范围限制
• 避免重写无关文档或修改历史决策（仅允许添加带日期的更新说明）

🛠 安装与启用方式

安装命令：

skills install --user reblocke/tcco2-accuracy

前置要求：

• 已安装 Claude-Code CLI 工具
• 拥有对目标代码仓库的读写权限

📋 标准工作流

1. 触发检测：当代码库中出现行为、设置、验证、公共文案、数据来源或工作流命令变更时
2. 文档扫描：自动检查 README.md、DECISIONS.md、docs/ 目录下相关文档及所有 ADR 文件
3. 变更分析：识别需要更新的文档内容，确保与代码变更保持一致
4. 文档更新：在同一个变更集中更新相关文档内容
5. 决策记录：将重要决策记录在 DECISIONS.md 或新建 ADR 中，避免仅保存在聊天记录中
6. 质量保证：保持文档简洁性和可操作性，明确记录变更内容、原因和操作指南

⚠️ 关键限制、缺陷、注意事项

• 平台限制：仅支持 Claude-Code CLI，不支持其他 Agent 工具
• 适用项目：适合需要严格文档维护的中大型项目，特别是开源项目或团队协作项目
• 不适合项目：小型个人项目或文档要求不严格的原型项目
• 使用要求：需要开发者具备良好的文档编写习惯，不能完全自动化生成文档
• 生产环境：可用于生产环境，但需要人工审核文档更新内容

✅ 适用场景 & ❌ 不适合场景

✅ 适用场景：

• 团队协作开发需要保持代码文档同步的项目
• 开源项目维护，需要高质量文档支持
• 涉及公共 API、重要架构决策的项目
• 需要长期维护和追溯决策历史的项目

❌ 不适合场景：

• 个人快速原型开发项目
• 文档要求极简或无需正式文档的项目
• 时间紧迫需要快速迭代的紧急项目
• 开发者缺乏文档编写习惯的团队