Claude Code 按代码变化更新开发文档
EnglishClaude Code 安装步骤
- 打开 GitHub 固定提交的 `.claude/skills/dev-doc/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.claude/skills/dev-doc/`,把核对后的文件保存为 `.claude/skills/dev-doc/SKILL.md`。
- 在该项目根目录启动 Claude Code,在斜杠菜单中选择 `/dev-doc`。
中文摘要
核对模块导出、目录和使用说明,只改需要更新的根文档或模块说明,避免多个页面重复内容。
SKILL.md 中文导读
可复现示例
模块 preview 把已有导出名称由 draftPreview 改为 reportPreview。项目源信息为 `{module:'preview',old:'draftPreview',current:'reportPreview'}`。根文档只列模块职责,模块 README 仍写旧名称。工作步骤
- 对照当前导出和目录,查看根文档及模块说明是否有过时内容。
- 只更新记录过时信息的说明,并复核路径、导出和模块数量。
验收方法
模块 README 改为 `export=reportPreview`。根文档保留模块职责,并确认模块名和目录仍正确。不要记录没有发生的其他接口改动。
GitHub 原文 · 更新日期
适用环境
Claude Code 项目工作区与现有开发文档。提交模块范围,或使用不带参数的完整文档审查。
常见问题
改完模块后如何判断哪些开发文档需要更新?
先比较源代码、根文档和模块说明。根文档只写主要职责,具体导出和使用方式放在模块说明。更新后核对路径和名称。