skills.rest
jeisenback
jeisenbackCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Reconcile project documentation with shipped code changes by updating key files.

Updated Mar 22, 2026
Search Tags:#automation#changelog#versioning#documentation#diff#docs#polish
One-click install
npx skills add https://github.com/jeisenback/original-curse-killer --skill document-release-jeisenback
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/jeisenback/original-curse-killer/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/jeisenback/original-curse-killer --skill document-release-jeisenback

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often diverges from what was actually shipped. This Skill automatically reads project diffs and updates key docs to reflect the shipped changes, reducing drift and manual rework.

Core Features & Use Cases

  • Automated cross-doc synchronization: updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • Change-log polish and TODOS cleanup: harmonizes CHANGELOG voice and cleans up outstanding TODOs without regressing history.
  • Proactive version alignment: optionally bumps VERSION and preserves historical entries when appropriate (subject to user confirmation).

Quick Start

From the repository root, run the document-release workflow to sync documentation with shipped 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 changes?▼

Automate post-ship documentation updates by reading project diffs and applying non-destructive edits to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md through a guided workflow that ensures consistency and prevents regressions.

What is the best way to sync my README and CHANGELOG with the latest shipped code?▼

Sync README and CHANGELOG files by automatically reconciling project documentation against shipped code diffs, polishing changelog voice, and cleaning up outstanding TODOs while preserving historical entries.

Can I automatically bump a VERSION file and preserve historical changelog entries?▼

Yes, you can proactively align versioning by optionally bumping the VERSION file and preserving historical changelog entries, subject to your explicit confirmation during the guided workflow.

Does this documentation automation workflow modify files destructively?▼

No, the documentation automation workflow performs non-destructive edits across repository files to preserve history and avoid regressions while applying updates to reflect the latest changes.

How does cross-doc synchronization work for multiple repository markdown files?▼

Cross-doc synchronization works by reading project diffs and applying guided updates across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to ensure tone and consistency match the shipped changes.

Related Skills

Explore More Content & Communication Skills→
tsenseitsensei
3

document-release

Scan project files and diffs to update documentation after shipping.

Community
Advanced
brainbrewlabsbrainbrewlabs
7

doc-publishing

Publishes documentation to GitHub Pages, Vercel, or Netlify from source docs and build outputs.

Official
Intermediate
Enso-SoftEnso-Soft
1

android-conventions

Standardize Android/Kotlin naming, patterns, and code style conventions.

Community
Basic
FutureAtomsFutureAtoms
1

git-github-changelog

Generate and update changelogs in Keep a Changelog format from Git commit history.

Community
Intermediate