docs-updater
Provides automated documentation updates by analyzing git changes between the current branch and the last release tag. Performs git diff analysis to identify modifications, then updates README.md, CHANGELOG.md following Keep a Changelog standard, and discovers documentation folders for contextual updates. Use when preparing a release, maintaining documentation sync, or before creating a pull request. Triggers on "update docs", "update changelog", "sync documentation", "update readme", "prepare r
Security Assessment
About docs-updater
This skill automates documentation maintenance by analyzing the git changes between the current branch and the most recent release tag, then proposing updates to the files that should change with them. It solves the recurring release chore of keeping README.md and CHANGELOG.md in sync with what actually shipped, following the Keep a Changelog standard and conventional-commit semantics to categorize changes into Added, Changed, Fixed, Removed, and Security sections.
The workflow runs in phases: verify the git repository and that release tags exist, detect the latest release version, perform diff analysis (commit counts, file statistics, commit messages, add/modify/delete status), discover documentation structure by scanning for docs folders and standard files, generate categorized changelog entries, and update README and documentation folders. Critically, it presents a summary of proposed changes and requires explicit user confirmation via AskUserQuestion before applying any edits. It declares only Read, Edit, and Bash tools, and the Bash usage is limited to read-only git inspection commands (git describe, git log, git diff, git rev-list) plus filesystem existence checks.
It targets maintainers and developers preparing a release, syncing docs after feature work lands, or reviewing what changed before opening a pull request. Because it edits documentation files in place, it modifies the working tree, but it does so only after presenting a review and getting approval, and it never pushes, deletes source code, or runs destructive commands.
FAQ
What does it need to run?
A git repository with at least one release tag to compare against. If no tags exist, the skill stops and tells you to create a release tag first. It also looks for README.md and CHANGELOG.md.
Which files does it change?
Primarily CHANGELOG.md and README.md, plus any discovered documentation folders (docs/, documentation/, doc/, and plugin-specific docs). Changelog entries follow the Keep a Changelog format.
Will it edit my docs without asking?
No. It presents a summary of proposed updates and requests explicit confirmation through AskUserQuestion before applying any edits.
What git operations does it perform?
Only read-only inspection: detecting the latest tag, listing commits and changed files, and computing diff statistics between the tag and HEAD. It does not commit, push, or rewrite history.
How does it categorize changes?
It parses commits using conventional-commit semantics and maps them into Keep a Changelog sections such as Added, Changed, Fixed, Removed, and Security.
Install docs-updater
Quick Setup:
- Copy the skill folder to
.claude/skills/ - Claude will automatically detect and use the skill
Repository
giuseppe-trisciuoglio/developer-kit