skills.rest
vibrationalforce
vibrationalforceCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Audit documentation diffs and update project docs to reflect current state.

Updated Oct 15, 2025
Search Tags:#changelog#documentation#workflows#documentation-review#diff-analysis#version-bump#pr-body
One-click install
npx skills add https://github.com/vibrationalforce/Echoelmusic --skill document-release-vibrationalforce
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/vibrationalforce/Echoelmusic/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/vibrationalforce/Echoelmusic --skill document-release-vibrationalforce

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill streamlines post-ship documentation maintenance by auditing project docs against shipped changes, ensuring README, ARCHITECTURE, CONTRIBUTING, and CLAUDE instructions stay accurate and up-to-date.

Core Features & Use Cases

  • Cross-checks diffs from the base branch to the current HEAD and identifies documentation drift.
  • Auto-updates or polishes CHANGELOG wording without overwriting existing entries.
  • Generates a discoverable doc health summary and a reader-friendly PR body with a per-file diff preview.
  • Applies updates across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect the latest state and practices.

Quick Start

Run the document-release skill to auto-synchronize post-ship docs across the project.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep documentation in sync after shipping code changes?▼

Documentation drift happens when shipped code changes are not reflected in existing docs. You can identify this drift by analyzing diffs between your base branch and HEAD, then updating README, ARCHITECTURE, and CONTRIBUTING files to match the current state.

How do I automatically generate a PR body with a file diff preview?▼

A doc health summary provides a cohesive overview of documentation consistency after shipping. It is generated by analyzing diffs between your base branch and HEAD, ensuring your README and ARCHITECTURE files enforce discoverability and safe-change guidance.

Can I update my CHANGELOG without overwriting previous entries?▼

Yes, you can update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files simultaneously. The process cross-checks diffs from the base branch to the current HEAD to apply accurate updates that reflect the latest project state and practices.

What is the best way to audit documentation drift in a repository?▼

You can polish CHANGELOG wording non-destructively by applying updates that refine existing entries without overwriting them. This ensures the version bump history remains intact while accurately reflecting new shipped changes.

Does this documentation review process work without external dependencies?▼

This documentation review process requires no external dependencies. It uses diff-analysis to audit project docs internally and generate a deterministic PR body and doc health summary directly from the repository state.

Related Skills

Explore More Content & Communication Skills→
akiyoshiakiyoshi

document-release

Audit documentation diffs between base and HEAD after a ship.

Community
Advanced
abhishekmmgnabhishekmmgn

document-release

Audit project docs against a diff and update key documentation files.

Community
Advanced
forbotsakeforbotsake
5

document-release

Synchronize post-release documentation with code changes after a PR merge.

Official
Advanced
JetBrainsJetBrains
10.2k

doc-sync

Detect and synchronize documentation discrepancies between code and doc files.

Official
Intermediate