document-release

Read project diffs and update post-ship documentation across core files.

2|Updated Mar 16, 2026
One-click install
npx skills add https://github.com/OmerFarukOruc/symphony-orchestrator --skill document-release-omerfarukoruc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/OmerFarukOruc/symphony-orchestrator/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/OmerFarukOruc/symphony-orchestrator --skill document-release-omerfarukoruc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common; this skill reads the project diff and updates distributed docs to reflect what shipped, ensuring the public documents stay aligned with the codebase.

Core Features & Use Cases

  • Sync documentation across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after PR merges or code ships.
  • Polish changelog voice, clean up TODOS, and optionally bump VERSION when appropriate.
  • Supports proactive documentation hygiene in teams that maintain multi-file project docs.

Quick Start

Run the post-ship docs workflow to sync and polish all project documentation after a merge.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I auto-update documentation after a merge to prevent doc drift?

Sync documentation across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md by reading project diffs and applying shipped changes. This keeps distributed project docs aligned with the codebase after merges.

What is post-ship documentation drift and how does automated syncing work?

Post-ship documentation drift occurs when distributed project docs become outdated after code changes. Automated syncing reads project diffs and updates core documentation artifacts to reflect exactly what shipped, maintaining alignment without manual intervention.

How do I polish changelog voice and clean up TODOs after shipping code?

Polish changelog voice and clean up TODOs by running a post-ship docs workflow that reads project diffs. It automatically refines changelog text and updates task lists to reflect the current state of merged code changes.

Can I automatically bump version numbers and surface changes in PR bodies?

Yes, you can bump version numbers and surface changes in PR bodies. The workflow provides automated guidance on whether a version bump is appropriate and how to accurately represent shipped changes within pull request descriptions.

Does this documentation sync approach work for repositories with multiple documentation artifacts?

This documentation sync approach works for repositories with multiple documentation artifacts. It updates distributed files like README and ARCHITECTURE simultaneously, supporting teams that maintain proactive documentation hygiene across multi-file projects.

When should I not use automated diff-based documentation updates?

You should not use automated diff-based documentation updates for repositories lacking multiple documentation artifacts or post-merge maintenance needs. It is designed for projects requiring consistent changelog voice and task list updates across distributed core files.