📌 Skill基础信息
Skill名称:Docs Sync
简称:docs-sync
来源:社区第三方(开发者 reblocke)
运行宿主:Claude-Code CLI
核心定位:在代码库行为、配置、验证逻辑或工作流命令发生变化时,自动检测并同步更新相关文档,确保代码与文档的一致性。
🧩 内部核心组成
该 Skill 主要通过规则约束和文档检测机制工作,包含以下核心组件:
文档检测范围:
- README.md 项目说明文档
- docs/DECISIONS.md 决策记录文档
- docs/ 目录下的所有相关文档
- ADR(Architecture Decision Record)架构决策记录
核心规则约束:
- 代码变更与文档更新同步进行
- 重要决策必须记录到持久化文档中
- 保持文档简洁性和可操作性
- 避免重写无关文档或修改历史决策
🛠 安装与启用方式
安装命令:
skills install --user reblocke/VBG_interpreter
前置依赖:
【无公开信息】
API/工具要求:
【无公开信息】
启动方式:
安装后自动集成到 Claude-Code CLI 工作流中,在检测到相关代码变更时自动触发。
📋 标准工作流
- 触发条件:当代码库中出现行为逻辑、配置设置、验证规则、公共文案、数据来源或工作流命令的变更时
- 文档检测:系统自动扫描 README.md、DECISIONS.md、docs/ 目录下文档以及所有 ADR 文件
- 变更分析:识别需要更新的文档内容,确保与代码变更保持一致
- 文档更新:在同一个变更集中同步更新相关文档内容
- 决策记录:将重要决策记录到 DECISIONS.md 或新建 ADR 文件中
- 质量保证:保持文档简洁性,明确记录变更内容、原因、运行方式和范围限制
⚠️ 关键限制、缺陷、注意事项
平台限制:仅支持 Claude-Code CLI 环境
适用项目:
- 中大型项目需要严格文档管理的场景
- 需要保持代码与文档高度一致的项目
- 有架构决策记录需求的系统
不适用项目:
- 小型或个人快速原型项目
- 文档要求不严格的场景
- 无需持久化决策记录的应用
生产环境适用性:适合生产环境使用,但需要团队建立相应的文档维护规范
已知注意事项:
- 需要开发者具备良好的文档编写习惯
- 不能完全替代人工的文档审查
- 对于历史决策的修改需要特别谨慎
✅ 适用场景 & ❌ 不适合场景
✅ 适用场景:
- 开发团队需要保持代码与文档同步的协作项目
- 有严格架构决策记录要求的企业级应用
- 需要可追溯决策过程的重要系统
- 开源项目维护和版本更新时的文档管理
❌ 不适合场景:
- 个人快速原型开发或实验性项目
- 文档要求简单或无需详细记录的小型应用
- 团队没有建立文档维护规范的情况
- 对历史决策频繁修改的非正式项目
如何安装
skills install --user reblocke/VBG_interpreter通用安装教程:在哪里输入上面的命令
上面的命令本质是在「终端 / 命令行」中调用技能管理器,把该 Skill 下载并注册到你的 AI 工具。各主流工具打开终端的位置不同,按下面操作即可:
- 打开工具自带的终端面板,或系统终端(macOS「终端」、Windows「PowerShell」、Linux「Terminal」)。
- 把上面的安装命令复制进去,回车运行,等待下载与注册完成。
- 重启或重新加载 AI 工具,让新安装的 Skill 被识别。
- 新建对话并触发:直接描述用途,或通过该工具的技能 / 斜杠菜单选中此 Skill。
Claude 桌面版(macOS / Windows)
桌面版没有内置命令行,Skill 需通过 Claude Code CLI 安装。打开系统终端,先执行 npm install -g @anthropic-ai/claude-code,再运行上面的安装命令;完成后完全退出并重新打开 Claude。
Claude Code(终端 CLI)
直接在项目目录的终端里运行上面的命令即可。也可先输入 claude 启动交互界面,再在对话中引用该 Skill(/ 斜杠菜单或直接描述用途)。
VS Code(含 GitHub Copilot)
打开终端面板:菜单「终端 → 新建终端」,或快捷键 Ctrl+`(macOS 为 ⌃+`)。在终端里运行上面的命令;装完后执行「重新加载窗口」(Ctrl+Shift+P → Reload Window),让 Copilot 等扩展识别新技能。
Cursor
底部「终端」面板(Ctrl+`)即是内置终端。粘贴运行上面的命令,完成后在命令面板执行「Reload Window」刷新,再开始对话。
Windsurf
底部「终端」面板运行命令;也可直接使用其内置 Agent 终端,在对话侧执行安装。
其他工具(ChatGPT、本地脚本等)
不支持本地终端的产品,可先在本机终端完成安装,再在对话中描述该 Skill 的能力让其调用;不同工具的命令格式请以其官方文档为准。
风险提示
本 Skill 的 SKILL.md 经自动扫描命中高危命令 / 数据外传 / 可疑链接等模式。安装与执行前务必人工逐行核验原始代码;本站已隐藏一键复制,避免误操作。
检测到数据外传行为(预设模式 #2)
命中检测项
- exfiltr
Aitishiku.com