Automated Doc Updates
Keep documentation in sync with your code using the /update-jamdesk skill for Claude Code.
The /update-jamdesk skill for Claude Code watches your code changes and generates matching documentation updates. Run it after you ship a user-facing feature. It finds the doc pages to create or edit.
Looking for general AI writing tips? See Claude Code for tool setup. See Writing with AI for broader guidance on writing docs with AI tools.
When to Use
Use when: You've made user-facing changes to APIs, CLI commands, UI, config options, or component behavior.
Skip when: Internal refactors, test-only changes, build/CI config, or performance work without behavior change.
Prerequisites
- Claude Code installed and configured
- A Jamdesk documentation project with
docs.json - Optional: Jamdesk CLI for verification (
npm install -g jamdesk)
Quick Start
Create a .jamdesk-docs-path file in your code repository pointing to your docs:
docs_path: ../my-docsThe path can be relative (from the config file) or absolute.
Run this after implementing a feature:
/update-jamdeskClaude analyzes your changes and asks clarifying questions before writing documentation.
Review the generated documentation. Claude verifies it with jamdesk validate and jamdesk broken-links before committing.
Config File Format
The .jamdesk-docs-path file tells Claude where your documentation lives.
Simple format with the path only:
../my-docsFull format with options:
# Path to documentation repository
docs_path: ../my-docs
# Optional: Branch for doc updates (default: main)
docs_branch: mainThe skill finds the config file by walking up from your current directory to the git root. Place it in your repository root.
How It Works
Claude runs these steps for /update-jamdesk:
- Locates your docs: finds the
.jamdesk-docs-pathconfig file - Asks questions: clarifies branch strategy, scope, and content
- Analyzes existing docs: searches for related content to update or extend
- Writes documentation: creates or updates pages following Jamdesk standards, with simple examples first
- Reviews tone: check the output for AI filler. Claude writes better with a CLAUDE.md that sets the voice (see Claude Code)
- Verifies: runs
jamdesk validateandjamdesk broken-links - Commits: stages changes and offers to commit/push/PR
Run git checkout . before committing to revert every edit.
| Scenario | Action |
|---|---|
| New feature | Create new page |
| Behavior change | Update existing page |
| Small addition | Add section to existing page |
| Major capability | New standalone page |
| Deprecation/removal | Update existing + add migration notes |
Example Session
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 Mode
Run with --preview to see what would change without making edits:
/update-jamdesk --previewPreview mode lets you:
- Check what documentation needs updating
- Review proposed changes before committing
- See the skill's analysis without side effects
Proactive Suggestions
Claude may suggest this after you commit user-facing code changes:
Tip: These changes affect user-facing features.
Run /update-jamdesk to update your documentation.This appears when:
- You have a
.jamdesk-docs-pathconfig file, AND - Your commit includes files matching user-facing patterns (API, CLI, components)
Installing the Skill
Install the /update-jamdesk skill using the skills CLI:
npx skills add jamdesk/skills --skill update-jamdeskThis installs the skill to .claude/skills/update-jamdesk/ in your project.
Installs to your current project directory:
npx skills add jamdesk/skills --skill update-jamdeskThe skill is available when working in this project.
Listing Available Skills
See all Jamdesk skills:
npx skills add jamdesk/skills --listUpdating
Re-run the install command to get the latest version:
npx skills add jamdesk/skills --skill update-jamdeskRestart Claude Code or start a new session after installing or updating.
Troubleshooting
Check that the skill file is at .claude/skills/update-jamdesk/SKILL.md. Then restart your Claude Code session.
Create .jamdesk-docs-path in your repository root with the path to your docs directory. The skill searches from your current directory up to the git root.
Install with npm install -g jamdesk. The skill works without it. It skips automated validation.