Automates updating README.md, CHANGELOG.md, and docs folders via git diff analysis of changes since last release tag. Use for release prep, PRs, or doc sync.
From developer-kitnpx claudepluginhub giuseppe-trisciuoglio/developer-kit --plugin developer-kitThis skill is limited to using the following tools:
references/examples.mdSearches, retrieves, and installs Agent Skills from prompts.chat registry using MCP tools like search_skills and get_skill. Activates for finding skills, browsing catalogs, or extending Claude.
Searches prompts.chat for AI prompt templates by keyword or category, retrieves by ID with variable handling, and improves prompts via AI. Use for discovering or enhancing prompts.
Guides agent creation for Claude Code plugins with file templates, frontmatter specs (name, description, model), triggering examples, system prompts, and best practices.
Automates the process of keeping project documentation synchronized with codebase changes. This skill analyzes git differences between the current working branch and the last released version, then intelligently updates relevant documentation files.
The Universal Documentation Auto-Updater provides a language-agnostic approach to documentation maintenance. By leveraging git operations to identify what has changed since the last release, it generates targeted updates for README.md, CHANGELOG.md, and project documentation folders.
Key Features:
Use this skill when:
Trigger phrases: "update docs", "update changelog", "sync documentation", "update readme", "prepare release documentation", "what changed since last release", "generate release notes"
Before starting, verify that the following conditions are met:
# Verify we're in a git repository
git rev-parse --git-dir
# Check that git tags exist
git tag --list | head -5
# Verify documentation files exist
test -f README.md || echo "README.md not found"
test -f CHANGELOG.md || echo "CHANGELOG.md not found"
If no tags exist, inform the user that this skill requires at least one release tag to compare against.
Goal: Identify the latest released version to compare against.
Actions:
# Get the most recent tag
LATEST_TAG=$(git describe --tags --abbrev=0 2>/dev/null)
# If no tags found, inform the user
if [ -z "$LATEST_TAG" ]; then
echo "No git tags found. This skill requires at least one release tag."
echo "Please create a release tag first (e.g., git tag -a v1.0.0 -m 'Initial release')"
exit 1
fi
echo "Latest release tag: $LATEST_TAG"
echo "Current branch: $(git branch --show-current)"
# Parse version from tag (handles v1.2.3, 1.2.3, release-1.2.3 formats)
VERSION=$(echo "$LATEST_TAG" | sed -E 's/^[^0-9]*([0-9]+\.[0-9]+\.[0-9]+).*/\1/')
echo "Version detected: $VERSION"
CURRENT_BRANCH=$(git branch --show-current)
echo "Comparing: $LATEST_TAG -> $CURRENT_BRANCH"
Goal: Analyze all changes between the last release and current branch.
Actions:
# Get commit count between tag and HEAD
COMMIT_COUNT=$(git rev-list --count ${LATEST_TAG}..HEAD 2>/dev/null || echo "0")
echo "Commits since $LATEST_TAG: $COMMIT_COUNT"
# Get file change statistics
git diff --stat ${LATEST_TAG}..HEAD
# Get all commit messages in the range
COMMITS=$(git log ${LATEST_TAG}..HEAD --pretty=format:"%h|%s|%b" --reverse)
# Display commits for review
echo "$COMMITS"
# Get list of changed files
CHANGED_FILES=$(git diff --name-only ${LATEST_TAG}..HEAD)
# Categorize changes by type
ADDED_FILES=$(git diff --name-only --diff-filter=A ${LATEST_TAG}..HEAD)
DELETED_FILES=$(git diff --name-only --diff-filter=D ${LATEST_TAG}..HEAD)
MODIFIED_FILES=$(git diff --name-only --diff-filter=M ${LATEST_TAG}..HEAD)
# Detect which components/areas changed
echo "$CHANGED_FILES" | grep -E "^plugins/" | cut -d'/' -f2 | sort -u
Goal: Identify all relevant documentation locations in the project.
Actions:
# Check for common documentation locations
DOC_FOLDERS=()
[ -d "docs" ] && DOC_FOLDERS+=("docs/")
[ -d "documentation" ] && DOC_FOLDERS+=("documentation/")
[ -d "doc" ] && DOC_FOLDERS+=("doc/")
# Find plugin-specific docs
for plugin_dir in plugins/*/; do
if [ -d "${plugin_dir}docs" ]; then
DOC_FOLDERS+=("${plugin_dir}docs/")
fi
done
echo "Documentation folders found:"
printf ' - %s\n' "${DOC_FOLDERS[@]}"
# Check for standard doc files
DOC_FILES=()
[ -f "README.md" ] && DOC_FILES+=("README.md")
[ -f "CHANGELOG.md" ] && DOC_FILES+=("CHANGELOG.md")
[ -f "CONTRIBUTING.md" ] && DOC_FILES+=("CONTRIBUTING.md")
[ -f "docs/GUIDE.md" ] && DOC_FILES+=("docs/GUIDE.md")
echo "Documentation files found:"
printf ' - %s\n' "${DOC_FILES[@]}"
Goal: Create categorized changelog entries following Keep a Changelog standard.
Actions:
See references/examples.md for detailed bash commands and changelog templates.
Goal: Update the main README with relevant high-level changes.
Actions:
Goal: Propagate changes to relevant documentation in docs/ folders.
Actions:
See references/examples.md for detailed discovery patterns and update strategies.
Goal: Show the user what will be updated before applying changes.
Actions:
## Proposed Documentation Updates
### Version Information
- Previous release: $LATEST_TAG
- Current branch: $CURRENT_BRANCH
- Commits analyzed: $COMMIT_COUNT
### Files to Update
- [ ] CHANGELOG.md - Add new version section with categorized changes
- [ ] README.md - Update [specific sections]
- [ ] docs/[specific files] - Update documentation
### Summary of Changes
**Added**: N new features
**Changed**: N modifications
**Fixed**: N bug fixes
**Breaking**: N breaking changes
Goal: Write the updates to the documentation files.
Actions:
# Read current changelog
CURRENT_CHANGELOG=$(cat CHANGELOG.md)
# Prepend new section
cat > CHANGELOG.md << 'EOF'
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
[New content goes here]
[Rest of existing changelog]
EOF
# For each documentation file that needs updates
# Use Edit tool to make precise changes
# Show what will change
git diff CHANGELOG.md
git diff README.md
git diff docs/
User request: "Update docs for the new features I just added"
Output:
User request: "Prepare documentation for v2.5.0 release"
Output:
User request: "Sync docs, I've made some changes"
Output:
See references/examples.md for detailed session transcripts and troubleshooting.