document-release

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

Updated Sep 13, 2026
One-click install
npx skills add https://github.com/abdulazeezoj/monovella-poc --skill document-release-abdulazeezoj
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/abdulazeezoj/monovella-poc/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/abdulazeezoj/monovella-poc --skill document-release-abdulazeezoj

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? After code ships, project documentation drifts out of sync with reality. This Skill audits README, ARCHITECTURE, CONTRIBUTING, CHANGELOG, and other docs against the actual diff, fixing stale claims and surfacing documentation debt before users hit it. ## Core Features & Use Cases - Diff-driven doc audit: Cross-references every documentation file against the branch diff, auto-applying factual fixes and asking before narrative changes. - Diataxis coverage map: Builds a reference/how-to/tutorial/explanation coverage matrix for shipped features and reports gaps as documentation debt in the PR body. - CHANGELOG voice polish and VERSION handling: Scores CHANGELOG entries with a sell-test rubric without rewriting them, and gates any VERSION bump behind explicit user approval. - Use Case: After merging a feature branch, run the Skill to update the README feature table, polish the CHANGELOG entry, clean up completed TODOS, and push a single docs commit with an updated PR body. ## Quick Start Ask the AI to update the project documentation to match what shipped on this 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 skill after a PR merges. It reads the branch diff, audits each documentation file against what shipped, auto-applies factual fixes, and asks before any narrative or structural changes.

How to keep a CHANGELOG accurate without rewriting entries?

The skill polishes voice only within existing CHANGELOG entries using a sell-test rubric scoring what changed, why it matters, and how to use it. It never deletes, reorders, or regenerates entries, and flags problems via user questions.

Does document-release work with GitLab merge requests?

Yes. The skill detects the hosting platform from the git remote and uses glab for GitLab or gh for GitHub to fetch and update the PR or MR body and title with the documentation summary.

Will it bump the VERSION file automatically?

No. Any VERSION bump requires explicit user approval through a decision prompt. If VERSION was already bumped, the skill checks whether the bump covers all shipped changes before recommending action.

What happens when documentation has gaps for new features?

The skill builds a Diataxis coverage map classifying each feature's documentation as reference, how-to, tutorial, or explanation. Gaps are reported as documentation debt in the PR body with a suggested docs-debt label.