document-release

Update project documentation and CHANGELOG after shipped code changes.

Updated Apr 15, 2026
One-click install
npx skills add https://github.com/256javy/safia --skill document-release-256javy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/256javy/safia/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/256javy/safia --skill document-release-256javy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation maintenance is tedious and error-prone. This Skill reads project docs, cross-references the shipped changes, and updates key artifacts (README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md) to reflect what shipped. It also polishes the CHANGELOG, cleans up TODOS, and can optionally bump the version.

Core Features & Use Cases

  • Reads project docs and diffs to identify what changed.
  • Updates documentation artifacts to align with the shipped state.
  • Proactively suggests doc updates after PRs are merged or code ships, and can bump VERSION when needed.

Quick Start

Ask me to run document-release after shipping to automatically sync the docs with the latest 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?

To automatically update documentation after shipping, you can use a post-ship docs sync tool that reads project diffs and updates artifacts like README, ARCHITECTURE, and CONTRIBUTING to reflect the latest changes.

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

Keeping a CHANGELOG and README in sync with merged PRs involves cross-referencing shipped code diffs with existing project docs and polishing the CHANGELOG to accurately reflect the new state.

Can I automatically bump the version number when updating post-ship documentation?

Yes, you can automatically bump the version number when updating post-ship documentation, as the docs sync process optionally includes version bumps alongside cleaning up TODOS and polishing the CHANGELOG.

How does syncing documentation with code diffs work?

Syncing documentation with code diffs works by reading the project docs, cross-referencing the shipped changes, and then editing key files like CLAUDE.md and ARCHITECTURE to align with the new shipped state.

Do I need to manually specify which files to update when syncing docs after a release?

No, you do not need to manually specify which files to update; the automation proactively identifies what changed by reading diffs and updates key artifacts like README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md accordingly.