document-release

Automate post-ship documentation updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files.

Updated Mar 28, 2026
One-click install
npx skills add https://github.com/zaeem-rafiq/tatheer-swift-sdk --skill document-release-zaeem-rafiq
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/zaeem-rafiq/tatheer-swift-sdk/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/zaeem-rafiq/tatheer-swift-sdk --skill document-release-zaeem-rafiq

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts as code ships. This Skill automatically reads project docs, compares them to what shipped, and updates user-facing files to reflect changes, ensuring consistency across READMEs, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and the CHANGELOG.

Core Features & Use Cases

  • Syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG voice and tidies up TODOS.
  • Optionally bumps VERSION when appropriate.
  • Proactively suggests documentation updates after a PR is merged or code is shipped.
  • Use Case: You merged major changes; run document-release to align all docs automatically.

Quick Start

Invoke the document-release skill after shipping to automatically align 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 a code release?

To update documentation after a code release, you analyze shipped code diffs and apply those changes across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to ensure docs remain consistent with the latest release.

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

Keeping changelogs and READMEs synced with merged PRs is best handled by running a post-ship diff analysis that automatically updates documentation files and polishes the CHANGELOG voice to reflect the merged changes accurately.

How does diff analysis work for syncing project docs?

Diff analysis for syncing project docs works by comparing shipped code changes against existing documentation, identifying discrepancies, and applying targeted updates across multiple files like CONTRIBUTING.md and CLAUDE.md to align with the new state.

Can I automatically bump the VERSION and clean up TODOS after shipping code?

Yes, you can automatically bump the VERSION file and clean up TODOS after shipping code. Post-ship documentation workflows handle version bumps when appropriate and remove completed TODOS alongside standard changelog polishing.

Do I need to manually update ARCHITECTURE.md and CLAUDE.md after a major release?

You do not need to manually update ARCHITECTURE.md and CLAUDE.md after a major release. Automated post-ship documentation tools proactively suggest and apply necessary updates to these files by analyzing the shipped code diff.

What are the limitations of automated documentation syncing for multiple files?

A limitation of automated documentation syncing is its reliance on accurate diff analysis; if shipped changes are highly ambiguous or lack clear user-facing impact, the automatic updates applied to README and changelog files may lack proper context.