文档同步

📌 Skill基础信息

• Skill名称：Docs Sync
• 简称：docs-sync
• 来源：社区第三方（开发者 reblocke）
• 运行宿主：仅能在支持 skills install 命令的 Agent 工具运行（具体宿主未在源码中明确，但通常为基于 MCP 或类似技能管理框架的 AI 开发工具，如某些定制化 CLI Agent）
• 核心定位：在代码行为、配置、验证逻辑或工作流命令发生变化时，自动检测并同步更新相关文档，确保代码与文档的一致性。

---

🧩 内部核心组成

本 Skill 为轻量级文档维护工具，不包含子 Agent 或复杂的命令体系。其核心组成如下：

• 文档检测范围：

- README.md

- docs/DECISIONS.md

- docs/ 目录下的相关文档

- 任何 ADR（架构决策记录）文件

• 规则约束：

- 要求代码变更与文档更新在同一提交中完成

- 持久化决策应记录于 DECISIONS.md 或新建 ADR，禁止仅隐藏在聊天记录中

- 文档应保持简洁、可操作：明确变更内容、原因、运行方法和未覆盖范围

• 目录结构依赖：

- 假设项目遵循标准文档结构（含 docs/ 目录和 ADR 文件）

---

🛠 安装与启用方式

1. 安装命令：

```bash

skills install --user reblocke/sodium_change

```

1. 前置依赖：

- 需所在 Agent 环境支持 skills install 指令（通常为 MCP 兼容工具）

- 本地需有 Git 管理的项目仓库（含 docs/ 目录或类似文档结构）

1. 启用方式：

- 安装后，Skill 会自动在代码变更场景中被触发（如检测到行为、配置、验证逻辑等变更）

---

📋 标准工作流

1. 用户行为：开发者在代码中提交涉及公共行为、命令、验证逻辑或数据来源的变更；
2. 自动触发：Skill 检测到上述变更后，自动扫描 README.md、docs/ 目录及 ADR 文件；
3. 文档更新建议：提示用户需同步更新相关文档，并给出需修改的文件列表；
4. 一致性检查：确保文档更新与代码变更处于同一提交中；
5. 决策记录：如涉及架构或持久化决策，引导用户写入 DECISIONS.md 或新建 ADR。

---

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

• 平台限制：仅适用于支持 skills install 的 Agent 环境（非通用 IDE 或编辑器）；
• 项目结构依赖：要求项目已有 docs/ 目录及 ADR 文件结构，否则无法正常运作；
• Token 消耗：未明确，但涉及文档扫描与差异对比，可能消耗中等量级 Token；
• 生产环境适用性：适用于中小型开源项目或内部项目文档维护，但需配合人工审核；
• 已知坑点：

- 不适用于无文档传统的项目或纯二进制仓库；

- 无法自动重写历史决策记录（仅支持追加新注释）；

- 对非标准文档目录结构支持较差。

---

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

✅ 适用场景

• 开源项目或团队协作项目，需保持代码与文档同步；
• 频繁迭代且涉及公共接口、CLI 命令、验证逻辑变更的项目；
• 已有 ADR 和决策记录规范的项目。

❌ 不适合场景

• 无文档或文档结构混乱的项目；
• 纯前端静态资源或二进制文件仓库；
• 高度定制化或非标准目录结构的项目；
• 无需严格文档同步的快速原型或实验性项目。

skills install --user reblocke/sodium_change

检测到数据外传行为（预设模式 #2）