skills.rest
JeremiahEllington
JeremiahEllingtonCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG after shipped changes.

Updated Apr 6, 2026
Search Tags:#documentation#claude#readme#polish#diff-analysis#post-ship
One-click install
npx skills add https://github.com/JeremiahEllington/NoahEllington --skill document-release-jeremiahellington
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/JeremiahEllington/NoahEllington/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/JeremiahEllington/NoahEllington --skill document-release-jeremiahellington

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is real. This skill updates and harmonizes docs to reflect what shipped, saving time and preventing inconsistencies.

Core Features & Use Cases

  • Cross-reference diffs and update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG to match shipped changes
  • Polish voice and tone for consistency across documentation
  • Optionally bump VERSION and polish TODOS as part of the release workflow

Quick Start

Run the document-release skill after a ship to update docs across the project and keep READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG in sync.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I update documentation after shipping a code change?▼

To update documentation after shipping, you can run the document-release skill to read diffs and automatically polish README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG files to match the shipped changes.

What is the best way to keep a README and CHANGELOG in sync with merged PRs?▼

Keeping a README and CHANGELOG in sync with merged PRs requires cross-referencing diffs against existing docs. This skill automates that process, harmonizing content and polishing voice across files for review readiness.

How does post-ship documentation drift happen and how do I fix it?▼

Post-ship documentation drift happens when shipped code changes outpace manual doc updates. You fix it by analyzing diffs and automatically applying language and structural updates across repository documentation to restore consistency.

Can I automatically bump a VERSION and polish TODOS during a release?▼

Yes, you can bump a VERSION and polish TODOS during a release. This is supported as an optional part of the post-ship workflow to ensure documentation and project tracking remain accurate.

Does document-release work without external dependencies?▼

Yes, document-release works without external dependencies. It operates independently to read diffs, cross-reference documentation, and polish language across the repository after a ship.

What files should I update when preparing documentation for a code review?▼

When preparing documentation for a code review, you should update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG. This skill ensures these files reflect shipped changes and maintain a consistent voice.

Related Skills

Explore More Content & Communication Skills→
fghaffarfghaffar

document-release

Update project docs by cross-referencing diffs after PR merges.

Community
Advanced
apeejay-educationapeejay-education

ship

Automate release workflows from branch merge to PR creation.

Official
Advanced
diiviikk5diiviikk5

document-release

Sync post-ship diffs across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Community
Advanced
tony30552001tony30552001

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code diffs.

Community
Advanced