skills.rest
algorithmbasics
algorithmbasicsCOMMUNITY
Explore all skills by this author →
𝕏@AlgorithmLlcGitHub

document-release

Update project documentation to match shipped changes after a release.

Updated Apr 18, 2026
Search Tags:#documentation#diff#CLAUDE.md#CHANGELOG#docs-sync#post-ship
One-click install
npx skills add https://github.com/algorithmbasics/gstack --skill document-release-algorithmbasics
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/algorithmbasics/gstack/tree/main/document-release
Command: npx skills add https://github.com/algorithmbasics/gstack --skill document-release-algorithmbasics

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is addressed by this skill. It reads all project docs, cross-references the diff, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what shipped; it also polishes the CHANGELOG, cleans up TODOS, and can bump VERSION when requested.

Core Features & Use Cases

  • Automated post-ship documentation synchronization across key docs
  • Changelog voice polishing and optional version bump
  • One-time routing and compliance checks after release

Quick Start

Run the post-ship docs updater to synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what shipped.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update project documentation after a release to match what shipped?▼

To update project documentation after a release, scan all docs and cross-reference the diff to align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with the shipped changes.

Can I automatically polish the CHANGELOG and bump VERSION during post-ship doc sync?▼

Yes, you can polish the CHANGELOG and bump VERSION during post-ship doc synchronization by performing updates with in-repo tooling like bash, read, write, and edit as part of the workflow.

What is post-ship documentation drift and how do in-repo tools fix it?▼

Post-ship documentation drift occurs when docs fail to reflect shipped changes; in-repo tools fix it by reading all project docs, cross-referencing the diff, and editing them to match the release.

Does this docs-sync workflow require external dependencies or components?▼

No, this docs-sync workflow requires no external dependencies or components, relying entirely on in-repo tooling like bash, read, write, and edit to update files.

When should I run a post-ship docs updater for my project?▼

You should run a post-ship docs updater immediately after a release to perform one-time routing and compliance checks, ensuring core docs match the actual shipped code.

What is the best way to clean up TODOS and align CLAUDE.md after shipping?▼

The best way to clean up TODOS and align CLAUDE.md after shipping is to run an automated post-ship docs updater that cross-references the release diff and edits the files accordingly.

Related Skills

Explore More Content & Communication Skills→
tony30552001tony30552001

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped code diffs.

Community
Advanced
Wilder1222Wilder1222
2

release

Automate release coordination with version tagging, changelog generation, and GitHub publication.

Community
Advanced
ligianehualigianehua

document-release

Update project documentation files based on the repository diff.

Community
Advanced
wodehwodeh

document-release

Automate post-ship documentation updates by scanning diffs and aligning project docs.

Community
Advanced