自动化文档更新
了解 /update-jamdesk Claude Code 技能如何将面向用户的代码变更转化为 Jamdesk 文档的对应更新。
Claude Code 的 /update-jamdesk 技能会监控你的代码变更，并生成相应的文档更新。在你发布面向用户的功能后运行它，它会找到需要创建或编辑的文档页面。
在寻找通用的 AI 写作技巧？ 工具设置请参阅 Claude Code。关于使用 AI 工具编写文档的更广泛指导，请参阅 使用 AI 编写。
何时使用
适用场景： 你对 API、CLI 命令、UI、配置选项或组件行为做出了面向用户的变更。
跳过场景： 内部重构、仅涉及测试的变更、构建/CI 配置，或不改变行为的性能优化。
前置条件
- 已安装并配置 Claude Code
- 一个包含
docs.json的 Jamdesk 文档项目 - 可选：用于验证的 Jamdesk CLI（
npm install -g jamdesk）
快速开始
在代码仓库中创建一个 .jamdesk-docs-path 文件，指向你的文档：
docs_path: ../my-docs路径可以是相对路径（相对于配置文件）或绝对路径。
在实现功能后运行：
/update-jamdeskClaude 会分析你的变更，并在编写文档前提出澄清问题。
审阅生成的文档。Claude 会在提交前使用 jamdesk validate 和 jamdesk broken-links 进行验证。
配置文件格式
.jamdesk-docs-path 文件告诉 Claude 你的文档位于何处。
简单格式，仅包含路径：
../my-docs完整格式，包含选项：
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: main该技能会从当前目录向上遍历至 git 根目录来查找配置文件。请将其放置在仓库根目录中。
工作原理
Claude 对 /update-jamdesk 执行以下步骤：
- 定位文档： 查找
.jamdesk-docs-path配置文件 - 提出问题： 澄清分支策略、范围和内容
- 分析现有文档： 搜索需要更新或扩展的相关内容
- 编写文档： 按照 Jamdesk 标准创建或更新页面，优先提供简单示例
- 审阅语气： 检查输出中是否有 AI 式的冗余填充语。通过设置定义语气的 CLAUDE.md，Claude 的写作会更好（参见 Claude Code）
- 验证： 运行
jamdesk validate和jamdesk broken-links - 提交： 暂存变更，并提供提交/推送/创建 PR 的选项
在提交前运行 git checkout .，可以撤销所有编辑。
| 场景 | 操作 |
|---|---|
| 新功能 | 创建新页面 |
| 行为变更 | 更新现有页面 |
| 小幅增补 | 在现有页面中添加章节 |
| 重大能力 | 新建独立页面 |
| 弃用/移除 | 更新现有页面并添加迁移说明 |
会话示例
User: I just added a webhook feature. Can you document it?
Claude: I'm using the update-jamdesk skill to update your documentation.
Found .jamdesk-docs-path: ../customer-docs
How should I handle changes to the docs repository?
1. Create a new feature branch (recommended)
2. Update directly on main
3. Use current branch
User: 1
Claude: Based on the webhook implementation, I plan to:
- Create: webhooks/overview.mdx
- Update: getting-started.mdx (add link)
Any changes to this plan?
User: Looks good
Claude: [Creates documentation...]
✓ jamdesk validate passed
✓ jamdesk broken-links passed
Commit these changes?预览模式
使用 --preview 运行，可以在不进行编辑的情况下查看将会发生的变更：
/update-jamdesk --preview预览模式允许你：
- 检查哪些文档需要更新
- 在提交前审阅建议的变更
- 查看技能的分析结果而不产生副作用
主动建议
在你提交面向用户的代码变更后，Claude 可能会给出以下建议：
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.出现此提示的条件：
- 你拥有
.jamdesk-docs-path配置文件，且 - 你的提交包含匹配面向用户模式的文件（API、CLI、组件）
安装技能
使用 skills CLI 安装 /update-jamdesk 技能：
npx skills add jamdesk/skills --skill update-jamdesk这会将技能安装到项目中的 .claude/skills/update-jamdesk/。
安装到当前项目目录：
npx skills add jamdesk/skills --skill update-jamdesk在此项目中工作时，该技能即可使用。
列出可用技能
查看所有 Jamdesk 技能：
npx skills add jamdesk/skills --list更新
重新运行安装命令以获取最新版本：
npx skills add jamdesk/skills --skill update-jamdesk安装或更新后，请重启 Claude Code 或开始新会话。
故障排除
检查技能文件是否位于 .claude/skills/update-jamdesk/SKILL.md。然后重启 Claude Code 会话。
在仓库根目录中创建 .jamdesk-docs-path，并写入文档目录的路径。该技能会从当前目录向上搜索至 git 根目录。
使用 npm install -g jamdesk 进行安装。没有它该技能也能工作，但会跳过自动化验证。