document-release

Synchronize README, ARCHITECTURE, CONTRIBUTING, and CLAUDE docs with shipped changes.

Updated Aug 27, 2026

Search Tags:#git #changelog #documentation #diff #release-management #polish #docs-sync

Ready to run

npx skills add https://github.com/TheLineExp/claude-code-platform --skill document-release-thelineexp

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/TheLineExp/claude-code-platform/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/TheLineExp/claude-code-platform --skill document-release-thelineexp

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped. Polishes CHANGELOG voice, cleans up TODOS.

Core Features & Use Cases

Automatically syncs README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
Cross-references diffs and updates the CHANGELOG with consistent voice.
Ensures cross-document consistency across release notes, docs, and project rules.

Quick Start

Run the document-release workflow after a release to automatically align docs with the shipped code.

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 a git release?▼

Automating documentation updates after a git release involves validating code diffs against existing docs and synchronizing project files like README.md and ARCHITECTURE.md. This ensures your documentation accurately reflects the shipped changes without manual review.

What is post-ship documentation alignment?▼

Post-ship documentation alignment is the process of cross-referencing git history diffs to update project documentation after features merge. It ensures cross-document consistency across README, CONTRIBUTING, and CHANGELOG files to match the exact code that shipped.

How do I keep README and ARCHITECTURE docs consistent with shipped code changes?▼

Keeping README and ARCHITECTURE docs consistent requires inspecting git history to validate diffs against documentation files. Synchronizing these files after feature merges ensures project rules and architecture descriptions accurately reflect the latest shipped changes.

Does document-release work for polishing changelog voice and cleaning up TODOs?▼

Yes, polishing changelog voice and cleaning up TODOs is supported during the documentation alignment process. It cross-references diffs to update the CHANGELOG with a consistent voice while simultaneously cleaning up outstanding TODOs across project docs.

When do I need to synchronize CLAUDE.md and CONTRIBUTING.md during release management?▼

You need to synchronize CLAUDE.md and CONTRIBUTING.md during release cycles or after feature merges to maintain cross-document consistency. This ensures project rules and contribution guidelines remain aligned with the shipped codebase.

What is the best way to sync multiple project docs after a feature merge?▼

The best way to sync multiple project docs is to run a post-ship workflow that inspects git diffs and automatically updates README, ARCHITECTURE, and CONTRIBUTING files. This approach ensures cross-document consistency across all project documentation.