Skill名称：docs-sync

简称：文档同步

来源：社区第三方（开发者reblocke）

运行宿主：只能在与MCP（Model Context Protocol）兼容的Agent工具中运行，例如Claude-Code CLI或Cursor等支持MCP协议的开发环境

核心定位：自动检测代码行为变更并同步更新相关文档，确保文档与代码实现的一致性，适合需要严格维护文档准确性的项目开发场景。

🧩 内部核心组成

该Skill主要基于规则约束和文档检查机制运行，不包含子Agent或斜杠命令。核心组成包括：

• 文档检查规则：系统化扫描README.md、docs/DECISIONS.md、ADR（架构决策记录）及其他相关文档
• 更新触发条件：当代码的公共行为、命令接口、验证逻辑或数据来源发生变化时自动触发
• 决策记录规范：要求将重要决策明确记录在结构化文档中，禁止仅保存在聊天记录中

目录结构监控：

项目根目录/
├── README.md
├── docs/
│   ├── DECISIONS.md
│   └── (其他文档)
└── (ADR文件)

🛠 安装与启用方式

安装命令：

skills install --user reblocke/conf_curve_likelihood

前置依赖：

• 支持MCP协议的开发环境（如Claude-Code CLI）
• Git版本控制系统

启用方式：安装后自动集成到开发环境中，在代码变更时自动触发文档检查流程

📋 标准工作流

1. 变更检测：开发者修改代码中的公共接口、命令行为、验证逻辑或数据溯源信息
2. 文档扫描：Skill自动扫描项目中的关键文档文件（README.md、DECISIONS.md、ADR等）
3. 一致性检查：比对代码变更与文档描述的匹配程度
4. 更新提示：识别出需要更新的文档内容并提供具体修改建议
5. 决策记录：重要变更要求记录到DECISIONS.md或新建ADR文件中
6. 文档优化：确保文档保持简洁可操作，包含变更内容、原因、运行方法和范围限制

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

平台限制：

• 仅支持MCP兼容的开发环境
• 依赖Git管理的项目结构

Token消耗：文档扫描和比对过程会产生一定的token消耗，与项目文档规模成正比

适用项目类型：

• 中大型项目 with 严格文档要求
• 需要维护决策记录的项目
• 多人协作开发项目

不适用场景：

• 小型个人项目
• 文档要求简单的原型项目
• 非代码文档维护场景

生产环境适用性：可用于生产环境，但需要团队建立相应的文档维护规范

已知坑点：

• 无法识别未通过Git跟踪的文档变更
• 对非标准文档结构的支持有限

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

✅ 适用场景：

• 企业级应用开发团队需要保持代码文档一致性
• 开源项目维护者需要确保API文档准确无误
• 需要严格记录架构决策和技术选型原因的项目
• 遵循严格合规要求的金融、医疗等行业软件项目

❌ 不适合场景：

• 快速原型验证阶段的项目
• 个人学习或实验性项目
• 文档极度简单或无文档要求的项目
• 非技术文档的维护和同步需求