document-release

Updates project documentation files to match shipped code changes after a release.

Updated Mar 26, 2026
One-click install
npx skills add https://github.com/LGJ-Jonathan/Jonathan_Global_Claude_Skills --skill document-release-lgj-jonathan
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/LGJ-Jonathan/Jonathan_Global_Claude_Skills/tree/main/gstack/document-release
Command: npx skills add https://github.com/LGJ-Jonathan/Jonathan_Global_Claude_Skills --skill document-release-lgj-jonathan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After shipping code, project documentation like README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG often drifts out of sync with what actually shipped. This Skill audits every documentation file against the git diff and brings them back into alignment before a PR merges. ## Core Features & Use Cases - Diff-driven doc audit: Reads all Markdown docs in the repo and cross-references them against the branch diff to find stale descriptions, wrong counts, and outdated paths. - Auto-update with guardrails: Applies clear factual fixes directly (tables, version numbers, file paths) while asking the user before narrative, security, or large rewrite changes. - CHANGELOG voice polish: Rewords existing CHANGELOG entries to lead with user value without ever deleting or regenerating entries. - TODOS and VERSION management: Marks completed TODO items, flags new deferred work, and asks before any version bump. - Use Case: After merging a feature branch that added a new command, run this Skill to update the README feature table, fix the skill count in CLAUDE.md, polish the CHANGELOG entry, and confirm the VERSION bump covers all changes. ## Quick Start Ask the assistant to run the document-release workflow to sync all project docs with the changes on the current feature branch.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update project documentation after shipping code?

Run the document-release workflow from a feature branch after code is committed. It reads every Markdown doc in the repo, compares them against the git diff, and applies factual corrections automatically while asking before risky narrative changes.

How to keep a CHANGELOG in sync with a release?

This Skill polishes existing CHANGELOG entries for user-facing voice without deleting or regenerating content. It only edits wording with exact string matches and asks the user if an entry looks wrong or incomplete.

Does document-release work with GitLab merge requests?

Yes, it detects the hosting platform from the git remote URL and supports both GitHub via gh and GitLab via glab. If neither CLI is available, it falls back to git-native commands to determine the base branch.

Will it bump my VERSION file automatically?

No, version bumps always require explicit user confirmation through a prompt. It also checks whether an existing bump covers all changes on the branch and asks if significant uncovered changes need their own version.

What documentation changes does it make without asking?

It auto-applies factual corrections clearly supported by the diff, such as adding items to tables, updating file paths and counts, fixing stale cross-references, and marking completed TODO items. Narrative, security, or large rewrites always require approval.