document-release

Align project documentation with shipped changes by analyzing diffs.

Updated Mar 19, 2026

Search Tags:#documentation #diff #README #CHANGELOG #docs-sync #CONTRIBUTING #ARIA.md

Ready to run

npx skills add https://github.com/shaneholloman/ship --skill document-release-shaneholloman

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/shaneholloman/ship/tree/main/document-release
Command: npx skills add https://github.com/shaneholloman/ship --skill document-release-shaneholloman

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship projects often drift where documentation no longer reflects shipped changes. This Skill ensures README, ARCHITECTURE, CONTRIBUTING, ARIA.md, and related docs stay accurate and consistent after a release.

Core Features & Use Cases

Cross-reference diffs to update READMEs and architecture notes to reflect shipped changes.
Polish CHANGELOG language and clean up TODOS to reflect final state.
Optionally bump package.json version when changes warrant a new release.

Quick Start

Run the document-release workflow to update all project documentation to reflect shipped changes.

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?▼

Keep documentation in sync by analyzing release diffs and cross-referencing files like README, ARCHITECTURE, and CONTRIBUTING to apply accurate, auditable post-ship edits automatically.

What is the best way to update README and CHANGELOG after a release?▼

The best way to update README and CHANGELOG after a release is to cross-reference shipped diffs against existing docs, polish the CHANGELOG language, and clean up TODOS to reflect the final project state.

Can I automatically bump package.json versions when updating project docs?▼

Yes, you can automatically bump package.json versions during the documentation update workflow when the analyzed shipped changes warrant a new release.

Does this docs-sync process support ARIA.md and architecture files?▼

Yes, the docs-sync process supports ARIA.md and architecture files by cross-referencing shipped diffs against these files to ensure all project documentation remains accurate and consistent.

How do I ensure post-ship documentation edits are safe and auditable?▼

To ensure post-ship documentation edits are safe and auditable, use a workflow that analyzes diffs and applies structured updates to README, TODOS, and other docs while tracking all changes.

When do I need to cross-reference diffs to update project documentation?▼

You need to cross-reference diffs to update project documentation when post-ship projects drift, ensuring that README, ARCHITECTURE, and CONTRIBUTING files accurately reflect the newly shipped code changes.