skills.rest
bhianerd
bhianerdCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Audit markdown documentation against git diffs after code releases.

1|Updated Mar 25, 2026
Search Tags:#documentation#release notes#version bump#cross-referencing#developer guides#post-ship updates#changelog voice
One-click install
npx skills add https://github.com/bhianerd/aimemory --skill document-release-bhianerd
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/bhianerd/aimemory/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/bhianerd/aimemory --skill document-release-bhianerd

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

It prevents your documentation from drifting out of date after code ships, so readers get accurate commands, structure, and terminology that match what was actually released.

Core Features & Use Cases

  • Post-ship documentation sync: Reads project documentation and updates key files to match what shipped, including README and contributor-facing docs.
  • Cross-reference consistency: Checks for contradictions between docs and the diff, then updates stale details and references.
  • Release-quality polish: Cleans up TODOs and polishes CHANGELOG voice without rewriting entries.
  • Optional version handling: Can bump version when appropriate (and asks before doing risky changes).

Use it when you are asked to update the docs, sync documentation, or do a post-ship doc refresh after a PR that changes behavior.

Quick Start

Type this command in chat: /document-release

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync post-ship documentation with recent codebase changes?▼

To sync post-ship documentation, you audit markdown files against the git diff to identify contradictions and update stale details like new commands or workflow updates so readers get accurate information matching the actual release.

What is the best way to update stale README and contributor guides after a release?▼

Updating stale README and contributor guides requires cross-reference consistency checks against codebase changes, applying conservative auto-updates for factual modifications while reserving manual prompts for risky narrative decisions or version bumps.

How do I clean up TODOs and polish CHANGELOG voice without rewriting entries?▼

Cleaning up TODOs and polishing CHANGELOG voice involves reviewing post-ship project documentation to update stale references, strictly avoiding clobbering or rewriting any existing CHANGELOG entries during the documentation refresh process.

Can I automatically update architecture docs and instruction files after a PR?▼

Architecture docs and instruction files can be automatically updated for factual changes after a PR, but the system requires a manual trigger and will use AskUserQuestion for risky narrative decisions or adding version and TODO additions.

Does post-ship documentation sync handle version bumps and developer guides?▼

Post-ship documentation sync handles developer guides by ensuring cross-reference consistency with the diff, and it can bump version numbers when appropriate by asking before executing risky changes to the project files.

Related Skills

Explore More Content & Communication Skills→
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced
louisfghbvclouisfghbvc
4

document-release

Update project documentation to align with shipped code changes.

Community
Advanced
IJHackIJHack
1.1k

qtpass-releasing

Automate QtPass releases by updating versions, building artifacts, and publishing to GitHub.

Official
Advanced
MFS-codeMFS-code
8

document-release

Audit markdown documentation against code diffs and update release notes.

Community
Advanced