Claude Code 手动同步实现与项目文档
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/docs-sync/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/docs-sync/`,把核对后的文件保存为 `.claude/skills/docs-sync/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/docs-sync`。
中文摘要
从实现差异判断需要修改的 README、说明文档和模板,再检查版本前提与命令用法。
SKILL.md 中文导读
可复现示例
虚构站点的筛选导出不再面向全部数据,前提是先选地点。旧 README 仍写全量导出,同样描述又出现在入门说明。样例 `{feature:'Export list',scope:'selected venue',requires:'choose a venue'}`。工作步骤
- 主动调用技能并附实现变更摘要,找出受影响的文档和模板。
- 写清新的用法及前提,合并重复说明,再核对实现中的名称。
验收方法
把主用法更新为 `scope=selected venue; prerequisite=choose a venue`。其它页面链接到这段说明,入门页增加一句如何选择地点,检查实际按钮名称一致。
GitHub 原文 · 更新日期
适用环境
Claude Code 工作区包含实现和已有文档。使用斜杠菜单主动调用,附上改动摘要。
常见问题
功能变化后怎样防止多份文档互相矛盾?
找出实现差异影响的说明,再选一处保存完整用法。其它文档引用该段,并按现有实现复核名称、路径和前置条件。