update-user-docs
Automatically updates documentation based on PR changes to keep user guides current.
Install
mkdir -p .claude/skills/update-user-docs && curl -L -o skill.zip "https://agentskills.codes/api/skills/download/17122" && unzip -o skill.zip -d .claude/skills/update-user-docs && rm skill.zipInstalls to .claude/skills/update-user-docs
Activation
This is the description your AI agent reads to decide when to run this skill — the better it matches your request, the more reliably it fires.
Auto-update user-facing documentation when a feature or behavior change ships. Run when dev invokes manually so they can add the doc to a PR ready-for-review. Optionally pass a PR number for an already-merged PR.Key capabilities
- →Auto-update user-facing documentation
- →Identify changed files and affected platforms from git diffs
- →Gather context from commit messages and Linear tickets
- →Determine if documentation updates are needed based on scope
- →Prefer updating existing pages for feature extensions
- →Create new pages for completely new features
How it works
This skill gathers context from git diffs, commit messages, and PR details to determine necessary documentation updates and then drafts changes to user-facing markdown files.
Inputs & outputs
When to use update-user-docs
- →Update docs from a merged PR
- →Sync docs based on branch diff
- →Generate documentation for a feature release
About update-user-docs
Monitors code changes via PRs or git history to update project documentation automatically. It ensures that user-facing docs reflect new features or behavioral changes without manual editing.
Auto-update user-facing documentation when a feature or behavior change ships. Run when dev invokes manually so they can add the doc to a PR ready-for-review. Optionally pass a PR number for an already-merged PR.
When not to use it
- →When the user needs to edit live docs outside of `apps/website/content/**`
- →When the user needs to update runtime code, app routes, or package interfaces
- →When the user needs to add or change theme, layout, route, component, or CSS code
Limitations
- →Edits live docs only under `apps/website/content/**`
- →Does not update runtime code, app routes, or package interfaces
- →Does not add or change theme, layout, route, component, or CSS code
How it compares
This workflow automates the process of synchronizing user documentation with code changes, reducing manual effort and ensuring accuracy.
Compared to similar skills
update-user-docs side by side with the closest alternatives in the catalog.
| Skill | Installs | Updated | Safety | Difficulty |
|---|---|---|---|---|
| update-user-docs (this skill) | 0 | 6mo | No flags | Intermediate |
| documentation-review | 11 | 6mo | No flags | Beginner |
| docs-review | 10 | 9mo | No flags | Beginner |
| workthrough | 10 | 10mo | Review | Beginner |
Try saying
Example prompts that trigger this skill in your AI assistant.
You might also like
documentation-review
stacklok
Reviews documentation for factual accuracy
docs-review
metabase
Review documentation changes for compliance with the Metabase writing style guide. Use when reviewing pull requests, files, or diffs containing documentation markdown files.
workthrough
bear2u
Automatically document all development work and code modifications in a structured workthrough format. Use this skill after completing any development task, bug fix, feature implementation, or code refactoring to create comprehensive documentation.
claude-md-improver
anthropics
Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".
anti-slop
rand
Comprehensive toolkit for detecting and eliminating "AI slop" - generic, low-quality AI-generated patterns in natural language, code, and design. Use when reviewing or improving content quality, preventing generic AI patterns, cleaning up existing content, or enforcing quality standards in writing, code, or design work.
agent-md-refactor
davila7
Refactor bloated AGENTS.md, CLAUDE.md, or similar agent instruction files to follow progressive disclosure principles. Splits monolithic files into organized, linked documentation.