skills.rest
filipnyquist
filipnyquistCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Read ship diffs and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Updated Mar 29, 2026
Search Tags:#versioning#documentation#release#docs#CHANGELOG#polish
One-click install
npx skills add https://github.com/filipnyquist/caidos --skill document-release-filipnyquist
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/filipnyquist/caidos/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/filipnyquist/caidos --skill document-release-filipnyquist

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often becomes out of date. This Skill reads diffs from the repo and updates core docs to reflect shipped changes, fixes wording in CHANGELOG, and nudges version bumps when needed.

Core Features & Use Cases

  • Reads project diffs after a ship and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG voice and cleans up TODOS to improve release communications.
  • Optionally bumps the VERSION when changes warrant a new release.

Quick Start

Run the document-release skill to synchronize project documentation with 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 automatically update documentation after shipping code changes?▼

You can automate documentation updates by reading the ship diff and applying those changes to README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md. This ensures your docs reflect shipped code accurately.

What is the best way to polish a CHANGELOG for a software release?▼

Polishing a CHANGELOG involves fixing the wording and cleaning up TODOS to improve release communications. This Skill processes your ship diff to refine the CHANGELOG voice automatically.

Can I automatically bump the VERSION file when changes justify a release?▼

Yes, you can automatically bump the VERSION file. This Skill optionally handles version bumps when the shipped changes warrant a new release, reading the diff to determine if it is needed.

How does synchronizing shipped docs with a repo diff work?▼

Synchronizing shipped docs works by reading the repository diff and applying the changes to key project files like README and ARCHITECTURE. This keeps your documentation current with the shipped code.

Do I need to manually update CONTRIBUTING and ARCHITECTURE docs after a ship?▼

No, you do not need to manually update CONTRIBUTING and ARCHITECTURE docs. This Skill targets those files specifically and applies the ship diff changes to them automatically.

Related Skills

Explore More Content & Communication Skills→
LazyIsEfficientLazyIsEfficient
15

documentation-writer

Apply diff-based documentation updates to docs/ and root README during PR workflows.

Official
Intermediate
grymmjackgrymmjack
19

create-release

Automate version increments, changelog compilation, and documentation updates for releases.

Community
Intermediate
I194I194
9

document-release

Scan project diffs and update core documentation to reflect shipped changes.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate