skills.rest
concept2cure
concept2cureCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation to reflect shipped code changes.

1|Updated Nov 13, 2025
Search Tags:#automation#workflow#documentation#release#diff#docs#CHANGELOG
One-click install
npx skills add https://github.com/concept2cure/ClinicalSageAI-2-replit --skill document-release-concept2cure
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/concept2cure/ClinicalSageAI-2-replit/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/concept2cure/ClinicalSageAI-2-replit --skill document-release-concept2cure

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from what shipped. This Skill reads diffs and updates key docs to reflect the released state, polishes tone, aligns contribution guidelines and architecture notes, and ensures the CHANGELOG and TODOS reflect reality.

Core Features & Use Cases

  • Doc alignment: syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to shipped reality.
  • Changelog polish: polishes CHANGELOG voice and cleans up TODOS.
  • Version bump readiness: optionally bumps VERSION when appropriate.
  • Workflow fit: used after PR merges or code shipped to keep docs current.

Quick Start

Run this after a PR is merged to sync and polish shipped documentation.

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 to reflect what shipped after a release?▼

To update project documentation after a release, you can detect shipped diffs and apply precise edits to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md. This ensures your docs accurately reflect the released state.

How do I keep my CHANGELOG and TODOS aligned with merged code automatically?▼

Keeping your CHANGELOG and TODOS aligned involves reading post-ship diffs to polish the changelog voice and clean up outdated TODOS. This syncs your project tracking files to reflect the actual shipped reality.

What is the best way to sync README and architecture notes after a PR merge?▼

The best way to sync README and architecture notes is to run a post-ship documentation workflow that detects code diffs and proposes precise edits. This aligns your docs with the merged reality.

Can I update CONTRIBUTING.md and CLAUDE.md references based on shipped code diffs?▼

Yes, you can update CONTRIBUTING.md and CLAUDE.md by detecting diffs from the shipped code and proposing targeted edits. This aligns contribution guidelines and architecture notes with the current state.

Why does my project documentation drift after shipping code?▼

Project documentation drifts after shipping because manual updates are often skipped. Automating diff detection and proposing precise edits to key docs prevents this drift and keeps references current.

Related Skills

Explore More Content & Communication Skills→
jamesjlundinjamesjlundin
32

pr-review

Analyze pull requests and generate structured review reports.

Community
Intermediate
j0KZj0KZ

release-publishing-workflow

Automate version bumps, CHANGELOG updates, npm publishing, and git tagging for a multi-package MCP monorepo.

Community
Advanced
richardadonnellrichardadonnell
45

changelog-automation

Generate changelogs from commit history using Conventional Commits and Keep a Changelog format.

Community
Intermediate
CentauriounCentaurioun

devtu-docs-quality

Detect and correct incorrect, outdated, and redundant documentation in ToolUniverse repositories.

Community
Advanced