skills.rest
steffenpharai
steffenpharaiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Update project documentation and version files after merged PRs.

Updated Aug 23, 2026
Search Tags:#workflow#changelog#documentation#release#diff#version#docs-sync
One-click install
npx skills add https://github.com/steffenpharai/StartupFramework --skill document-release-steffenpharai
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/steffenpharai/StartupFramework/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/steffenpharai/StartupFramework --skill document-release-steffenpharai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone. This Skill reads project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to reflect shipped changes, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when you need to align docs after a PR is merged or code is shipped.

Core Features & Use Cases

  • Cross-document syncing: updates several key docs to stay in sync with what shipped.
  • CHANGELOG polish: refines tone and consistency across entries.
  • TODOS cleanup and optional version bump: helps maintain a clean release narrative.

Quick Start

Run the document-release workflow on a ship-ready branch to synchronize all docs and prep the PR for merging.

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 merging a PR?▼

Automating documentation updates after a PR merge requires reading project diffs and cross-referencing them with existing docs. This Skill aligns README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, and CHANGELOG files with shipped changes to keep everything in lockstep.

What is the best way to keep my CHANGELOG consistent with shipped code changes?▼

Keeping a CHANGELOG consistent with shipped code involves cross-referencing diffs against project docs and refining the entry tone. This Skill polishes CHANGELOG voice, cleans up TODOS, and optionally bumps the VERSION file after code is shipped.

Do I need specific tools to sync README and ARCHITECTURE files with my codebase?▼

Syncing README and ARCHITECTURE files relies on standard repository tools like Bash, Read, Write, Edit, Grep, and Glob. This Skill uses these allowed-tools to read diffs and update key documentation automatically.

Can I automatically clean up TODOS and bump VERSION files during a release?▼

Cleaning up TODOS and bumping VERSION files during a release is fully supported. This Skill operates across key project docs, polishing the release narrative and optionally incrementing the VERSION after a PR is merged.

Why does my project documentation drift out of sync after shipping code?▼

Documentation drifts after shipping because manual updates across multiple files are tedious and error-prone. This Skill solves the problem by cross-referencing code diffs and synchronizing README, CONTRIBUTING, and CLAUDE.md files with the actual shipped changes.

Related Skills

Explore More Content & Communication Skills→
ajsai47ajsai47
11

document-release

Update project markdown documentation by cross-referencing git diffs after code commits.

Community
Advanced
dhntdhnt

tag-release

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

Official
Intermediate
Jia-Hong-PengJia-Hong-Peng

document-release

Synchronize project documentation with shipped code changes across multiple document types.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate