skills.rest
onlypfachi
onlypfachiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Cross-reference shipped changes and update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG.

Updated Mar 19, 2026
Search Tags:#documentation#release-management#CHANGELOG#docs-automation#pr-prep#documentation-polish#diff-sync
One-click install
npx skills add https://github.com/onlypfachi/chief --skill document-release
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/onlypfachi/chief/tree/main/document-release
Command: npx skills add https://github.com/onlypfachi/chief --skill document-release

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This skill automates updating project docs to reflect what shipped, ensuring READMEs, architecture notes, and CONTRIBUTING guidance stay aligned.

Core Features & Use Cases

  • Cross-reference and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match shipped changes.
  • Polish CHANGELOG voice, refresh TODOS, and optionally bump VERSION after verified diffs.
  • Proactively suggest documentation updates after PR merges or code ships.

Quick Start

Review the latest PR changes and automatically regenerate and align the documentation across core docs.

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 with shipped code changes automatically?▼

To keep documentation in sync with shipped code changes, this Skill cross-references recent PR merges with core docs like README, ARCHITECTURE, and CONTRIBUTING, then updates them to match the shipped features.

What is the best way to automate CHANGELOG generation and polishing after a release?▼

Automating CHANGELOG generation and polishing involves refreshing the changelog voice, updating TODOs, and optionally bumping the VERSION file after verifying the diffs against shipped code changes.

How does documentation drift happen and how can I fix it across multiple core docs?▼

Documentation drift happens when shipped changes aren't reflected in core docs, which you can fix by cross-referencing the latest PR changes and automatically regenerating and aligning README, ARCHITECTURE, and CLAUDE.md files.

Can I generate a documentation diff preview for a PR body before merging?▼

Yes, you can generate a documentation diff preview for a PR body by cross-referencing shipped changes with core docs, allowing you to review proposed README and CHANGELOG updates before merging.

Does this documentation automation tool work without external dependencies or components?▼

Yes, this documentation automation tool works without external dependencies or components, operating independently to analyze shipped changes and align project documentation.

When should I trigger documentation updates in a release-readiness workflow?▼

You should trigger documentation updates in a release-readiness workflow proactively after PR merges or code ships, ensuring READMEs, architecture notes, and CONTRIBUTING guidance stay aligned.

Related Skills

Explore More Content & Communication Skills→
fray-cloudfray-cloud

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
JansenAnalyticsJansenAnalytics
5

release-manager

Automate changelog generation, version bumps, and GitHub releases via CLI.

Community
Intermediate
dragoscirjandragoscirjan

lang-md

Standardize Markdown formatting with Google style, Prettier, and markdown lint.

Community
Basic
shekerkammashekerkamma

document-release

Update project documentation to match shipped code changes.

Community
Advanced