document-release

Automatically updates README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md after shipped changes.

2|Updated Mar 20, 2026
One-click install
npx skills add https://github.com/nicholaslocascio/x-claw-studio --skill document-release-nicholaslocascio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/nicholaslocascio/x-claw-studio/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/nicholaslocascio/x-claw-studio --skill document-release-nicholaslocascio

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what was shipped. This skill ensures your docs stay in sync with the actual release by updating multiple core documents to reflect the shipped changes.

Core Features & Use Cases

  • Update core docs: Read diffs and align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what shipped.
  • Changelog polish: Improve CHANGELOG wording for clarity and consistency.
  • Todo hygiene: Clean up and tidy TODOS to reflect completed work.
  • Version handling: Optionally bump VERSION when changes warrant a new release.

Quick Start

Run document-release after shipping changes to automatically synchronize the project docs with the release.

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 releases automatically?

To keep documentation in sync with shipped releases, you can run a post-ship automation skill that reads code diffs and updates core markdown files like README and ARCHITECTURE to reflect the actual shipped changes.

What is the best way to update a markdown changelog after shipping code?

Updating a markdown changelog after shipping is best handled by automating diff analysis to polish existing changelog entries, ensuring post-ship governance by preserving history and enforcing consistency across all project documentation.

Does this release management skill work with core docs like CONTRIBUTING and ARCHITECTURE markdown files?

Yes, this release management skill operates directly on core markdown docs including README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md, aligning their content with the shipped code changes to prevent documentation drift.

How do I tidy up TODOS and bump VERSION files after a release?

To tidy TODOS and bump VERSION files after a release, use a post-ship documentation skill that optionally updates version numbers and cleans up todo lists to reflect completed work alongside standard documentation updates.

Can I use diff analysis to prevent post-ship documentation drift?

Yes, you can use diff analysis to prevent post-ship documentation drift by automatically reading shipped changes and applying those updates to core documentation files, ensuring changelog history and project docs remain consistent.