skills.rest
bobbo01
bobbo01COMMUNITY
Explore all skills by this author →
GitHub

document-release

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

Updated Mar 16, 2026
Search Tags:#changelog#documentation#markdown#readme#release#git diff#post-ship
One-click install
npx skills add https://github.com/bobbo01/B2BPlatform --skill document-release-bobbo01
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/bobbo01/B2BPlatform/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/bobbo01/B2BPlatform --skill document-release-bobbo01

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, applies factual corrections automatically, and flags risky narrative changes for review. ## Core Features & Use Cases - Diff-Driven Doc Audit: Reads all Markdown docs and cross-references them against the branch diff to find stale paths, counts, commands, and feature lists. - CHANGELOG Voice Polish: Rewrites entry wording to be user-forward without ever deleting or regenerating existing entries. - TODOS Cleanup & VERSION Check: Marks completed TODO items, surfaces new deferred work, and asks before any version bump. - Use Case: After merging a feature branch that added a new CLI command, run this Skill to update the README command table, fix stale setup steps in CONTRIBUTING, and polish the CHANGELOG entry before the PR merges. ## 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 committing code. It diffs against the base branch, audits every Markdown file, auto-applies factual fixes like paths and counts, and asks before narrative or version changes.

What documentation files does a post-ship doc audit cover?▼

The audit covers README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md or project instructions, CHANGELOG, TODOS, and VERSION. It discovers all Markdown files up to two levels deep and cross-references each against the branch diff.

Does document-release work with GitLab as well as GitHub?▼

Yes. It detects the platform from the git remote URL, using gh for GitHub and glab for GitLab to find the base branch. If neither CLI is available, it falls back to git-native commands like symbolic-ref and rev-parse.

Will this workflow overwrite my CHANGELOG entries?▼

No. The workflow only polishes wording inside existing CHANGELOG entries using exact-match edits. It never deletes, reorders, or regenerates entries, and it asks before any change that would alter meaning.

When should I not run a post-ship documentation update?▼

Do not run it on the base branch itself; the workflow aborts if you are not on a feature branch. It is also unnecessary when the branch contains no user-facing or structural changes that docs describe.

Related Skills

Explore More Software Engineering Skills→
IntegralistIntegralist
2

bcp

Automates creating a feature branch, committing changes, and opening a pull request with Git.

Community
Intermediate
kortix-aikortix-ai
20.2k

changelog-sync

Generates release notes from merged GitHub PRs and opens changelog pull requests.

Official
Advanced
bearhedgebearhedge

test-driven-development

Enforce test-first development with failing tests before production code.

Community
Basic
dimsourdimsour
2

document

Generate XML doc comments, READMEs, and OpenAPI descriptions from .NET source code.

Community
Advanced