document-release

Audit release diffs and update core documentation files to match shipped changes.

8|Updated Mar 17, 2026

Search Tags:#changelog #architecture #documentation #readme #release #diff #contributing

Ready to run

npx skills add https://github.com/ShaheerKhawaja/ProductionOS --skill document-release-shaheerkhawaja

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ShaheerKhawaja/ProductionOS/tree/main/skills/document-release
Command: npx skills add https://github.com/ShaheerKhawaja/ProductionOS --skill document-release-shaheerkhawaja

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.

Core Features & Use Cases

Cross-checks release diffs against documentation across multiple core docs to ensure alignment with shipped changes.
Automated updates to README.md, ARCHITECTURE.md, CONTRIBUTING.md, CLAUDE.md, and CHANGELOG.md to reflect actual shipped content.
Handles selective scope updates and preserves existing doc style while applying corrections.

Quick Start

Run document-release after a release to synchronize all shipped docs with the latest changes.

Frequently Asked Questions about document-release

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

FAQPage Schema

How do I automatically update documentation after a release?▼

Automating post-release documentation alignment involves auditing the release diff and applying updates to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md. This ensures all shipped files accurately reflect the latest changes while preserving existing doc style.

What is the best way to keep a changelog and readme in sync with shipped code?▼

Keeping a changelog and readme in sync with shipped code requires cross-referencing release diffs against project documentation. This approach applies idempotent edits and consistent styling across multiple core docs to accurately match what actually shipped.

How does post-ship documentation alignment work for multiple core docs?▼

Post-ship documentation alignment works by reading all project docs, cross-referencing them against the release diff, and applying corrections. It selectively updates scoped repository paths while preserving existing doc style across README, ARCHITECTURE, CONTRIBUTING, and CHANGELOG files.

Can I update documentation for a specific repository scope instead of the whole project?▼

Yes, you can update documentation for a specific repository scope. The documentation alignment process applies to the repository scope or repo path provided, allowing selective scope updates rather than forcing changes across the entire project.

Do I need diff data to synchronize documentation with shipped changes?▼

Yes, you need diff data to synchronize documentation with shipped changes. The documentation alignment process requires access to diff data to audit what shipped and apply accurate updates to your core project files.

Will automated documentation updates overwrite my existing doc style?▼

Automated documentation updates will not overwrite your existing doc style. The synchronization process preserves existing doc style while applying corrections, enforcing idempotent edits with consistent styling across multiple docs.