skills.rest
lemig
lemigCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project documentation and CHANGELOG after software releases.

Updated May 14, 2026
Search Tags:#changelog#architecture#documentation#claude#readme#post-release
One-click install
npx skills add https://github.com/lemig/transcriptor --skill document-release-lemig
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/lemig/transcriptor/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/lemig/transcriptor --skill document-release-lemig

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-release documentation often drifts between files (READMEs, ARCHITECTURE, CONTRIBUTING, CLAUDE.md). This skill automatically reads all relevant project docs and updates them to reflect shipped changes, reducing manual effort and human error.

Core Features & Use Cases

  • Unified post-ship documentation sync across core project documents.
  • Polishes CHANGELOG voice and ensures README and architecture notes match shipped changes.
  • Proactively suggests updates to CLAUDE.md and CONTRIBUTING when docs drift after a PR or release.

Quick Start

Run the document-release skill to align docs after a release.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-release documentation updates for multiple project files?▼

Automating post-release documentation updates involves reading all relevant project docs like READMEs, ARCHITECTURE, and CONTRIBUTING files, then applying shipped changes to enforce consistency and reduce manual effort across the project.

Why does my README and CHANGELOG drift after a release?▼

README and CHANGELOG drift occurs when shipped changes are not manually reflected across all project documents. This happens frequently after PRs or releases when architecture notes and documentation are not synchronized with the new codebase state.

What is the best way to keep CLAUDE.md and CONTRIBUTING docs consistent after a ship?▼

Keeping CLAUDE.md and CONTRIBUTING docs consistent after a ship requires a unified documentation sync process that proactively identifies doc drift and applies updates to match the shipped components and architecture changes.

Can I automatically polish my CHANGELOG voice to match shipped changes?▼

Yes, polishing CHANGELOG voice can be automated by reading shipped changes and applying consistent tone and formatting updates to the CHANGELOG, ensuring it aligns with the actual release modifications.

How to sync architecture notes and READMEs with shipped code changes?▼

Syncing architecture notes and READMEs with shipped code requires reading the post-release modifications and applying those updates across all core project documents to maintain alignment and prevent documentation drift.

Related Skills

Explore More Software Engineering Skills→
ShaheerKhawajaShaheerKhawaja
8

productionos-document-release

Sync shipped code changes with project documentation to correct drift.

Community
Intermediate
LaPaGaYoLaPaGaYo

document-release

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

Community
Advanced
TwoTonedTwoToned

document-release

Scan shipped changes and update project documentation files.

Official
Advanced
Wesley1600Wesley1600

markdown-formatter

Format and validate Markdown documents with TOC generation and conversion.

Community
Intermediate