skills.rest
sanskarbasnet
sanskarbasnetCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Align README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with shipped changes.

1|Updated May 4, 2026
Search Tags:#automation#documentation#release#CLAUDE.md#CHANGELOG#docs-sync
One-click install
npx skills add https://github.com/sanskarbasnet/fstack --skill document-release-sanskarbasnet
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/sanskarbasnet/fstack/tree/main/document-release
Command: npx skills add https://github.com/sanskarbasnet/fstack --skill document-release-sanskarbasnet

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common; this skill automates updating critical docs to reflect shipped changes, ensuring readers see accurate READMEs, architecture notes, contributor guidelines, and CLAUDE.md.

Core Features & Use Cases

  • Auto-aligns RELEASE documentation across the repository by updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what's shipped.
  • Polishes CHANGELOG entries and cleans up pending TODOS to keep project history clean.
  • Optionally bumps VERSION after a successful release to keep versioning in sync.

Quick Start

Run after a release to synchronize and polish repository docs.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a release?▼

Post-release documentation updates are automated by reading shipped changes and aligning READMEs, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect the new state. It triggers on release events or explicit requests.

What is the best way to keep CLAUDE.md and CHANGELOG in sync with shipped changes?▼

Keeping CLAUDE.md and CHANGELOG in sync is done by automating post-ship tasks that polish CHANGELOG entries, clean pending TODOS, and update CLAUDE.md based on shipped changes across the repository.

Can I automatically bump VERSION numbers across my repository after shipping?▼

Yes, version bumps can be optionally applied across the repository after a successful release to keep versioning in sync with the shipped code and updated documentation.

Does automating post-ship docs work without external dependencies?▼

Automating post-ship docs works without external dependencies, though it requires access to repository tools to read project files and trigger on release events or explicit user requests.

When should I run a repository docs-sync to prevent documentation drift?▼

A repository docs-sync should be run immediately after a release to prevent documentation drift, ensuring readers see accurate READMEs and architecture notes reflecting what shipped.

Related Skills

Explore More Content & Communication Skills→
lemiglemig

document-release

Update project documentation and CHANGELOG after software releases.

Community
Advanced
dhntdhnt

tag-release

Create and push annotated Git tags for version-bump commits.

Official
Intermediate
fiftynotaififtynotai
10

release

Generate changelogs and semantic version bumps from git commit history.

Community
Intermediate
lan99mulan99mu
3

confluence-markdown

Synchronize Confluence pages with Markdown files using Python libraries.

Community
Intermediate