document-release

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

Updated May 1, 2026
One-click install
npx skills add https://github.com/ricardoo022/4dill --skill document-release-ricardoo022
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ricardoo022/4dill/tree/main/.gemini/skills/document-release
Command: npx skills add https://github.com/ricardoo022/4dill --skill document-release-ricardoo022

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 in the repo and cross-references them against the branch diff to find stale descriptions, wrong paths, outdated counts, and broken cross-references. - CHANGELOG voice polish: Rewrites entry wording to lead with user value while strictly preserving all existing content, never regenerating or deleting entries. - TODOS cleanup and consistency checks: Marks completed TODO items, verifies version numbers match across files, and ensures every doc is discoverable from README or CLAUDE.md. - Use Case: After merging a feature branch that added a new CLI command, run this Skill to update the README feature table, fix the project structure section in CLAUDE.md, and polish the CHANGELOG entry before the PR merges. ## Quick Start Ask the assistant to run the document-release workflow to sync all project documentation 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 this Skill from a feature branch after committing code. It diffs the branch against the base branch, audits every Markdown file, auto-applies factual fixes like paths and counts, and asks before making narrative or structural changes.

How to polish a CHANGELOG without losing existing entries?▼

The Skill reads the full CHANGELOG first and only edits wording within existing entries using exact string matches. It never deletes, reorders, or regenerates entries, and asks before any rewrite that would alter meaning.

Does this work with GitLab merge requests or only GitHub?▼

It supports both. The Skill detects the platform from the git remote URL, falling back to gh or glab CLI authentication checks, and uses git-native commands when neither platform CLI is available.

What documentation changes require manual approval?▼

Narrative changes, section removals, security model updates, large rewrites over roughly ten lines, VERSION bumps, and new TODOS items always prompt for confirmation. Factual corrections from the diff are applied automatically.

When should I not run the document-release workflow?▼

Do not run it on the base branch, since it aborts immediately there. It is designed for the window after code is committed on a feature branch but before the pull request merges.