skills.rest
adityasingh2400
adityasingh2400COMMUNITY
Explore all skills by this author →
Website𝕏@NoeticPraxisGitHub

document-release

Cross-reference shipped diffs and update Markdown project documentation.

2|Updated Apr 4, 2026
Search Tags:#documentation#post-release#CLAUDE.md#CHANGELOG#diff-analysis#documentation-sync
One-click install
npx skills add https://github.com/adityasingh2400/SwarmSell --skill document-release-adityasingh2400
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/adityasingh2400/SwarmSell/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/adityasingh2400/SwarmSell --skill document-release-adityasingh2400

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation can drift after changes. This skill reads all project docs, cross-references the shipped diff, and updates key files to reflect what actually shipped, reducing drift and confusion.

Core Features & Use Cases

  • Automatically syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes.
  • Polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION to match the release.
  • Use after PR merge or code shipping to ensure documentation stays aligned with the codebase.

Quick Start

Run document-release after shipping to automatically align project 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 README and CLAUDE.md after a release?▼

You can sync project documentation post-release by cross-referencing the shipped diff against existing docs. This automatically updates README, CLAUDE.md, and other Markdown files to reflect the latest code changes.

What is post-release documentation drift?▼

Post-release documentation drift occurs when project docs like README, ARCHITECTURE, and CONTRIBUTING become outdated after shipping code changes. Diff-aware automation reads the shipped changes to sync documentation automatically.

How do I polish a CHANGELOG and clean up TODOS after merging a PR?▼

You can polish a CHANGELOG and clean up TODOS by running a post-ship documentation workflow that analyzes the merged diff, updates the voice of release notes, and removes completed tasks from Markdown files.

Does diff-analysis help keep Markdown documentation synced with shipped code?▼

Yes, diff-analysis compares the shipped code changes against existing project documentation. It ensures that updates to README, ARCHITECTURE, and CLAUDE.md files accurately reflect the actual codebase modifications.

Can I bump the VERSION file automatically when syncing post-ship documentation?▼

Yes, you can bump the VERSION file automatically. Post-release documentation workflows can optionally update the VERSION file alongside syncing Markdown docs and polishing the CHANGELOG to match the release.

When should I run a documentation sync workflow for my project?▼

You should run a documentation sync workflow immediately after shipping code or merging a PR. This ensures your README, ARCHITECTURE, and CONTRIBUTING docs stay aligned with the codebase before drift occurs.

Related Skills

Explore More Content & Communication Skills→
dogeareddogeared

document-release

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

Community
Intermediate
sanskarbasnetsanskarbasnet
1

document-release

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

Community
Intermediate
olafkfreundolafkfreund
21

gemini-commands

Create reusable Gemini CLI slash commands defined in TOML files.

Community
Basic
rahmanayonrahmanayon

document-release

Update project documentation to reflect shipped changes and polish changelog voice.

Community
Advanced