document-release

Automating documentation sync verifies markdown files against git diffs to detect stale information. This Skill cross-references README, ARCHITECTURE, and CONTRIBUTING files with codebase changes to ensure documentation consistency after a release.

Refining a changelog involves applying a Diataxis-based rubric to ensure entries are user-focused and actionable. This Skill audits changelog entries during post-ship workflows, polishing them to maintain high-quality, discoverable documentation that accurately reflects shipped changes.

Validating architectural diagrams against git diffs is part of the documentation audit process. This Skill verifies consistency between codebase changes and architectural documentation, ensuring diagrams remain accurate after shipping.

Tracking documentation debt requires auditing discoverability and cross-links across project files. This Skill automates PR body updates and manages version bumps, ensuring documentation remains discoverable while maintaining debt tracking.

This documentation audit approach works without external dependencies, relying entirely on internal scripts. It cross-references markdown files against git diffs to identify stale information and verify consistency, requiring no additional tools or libraries.

Automated documentation synchronization suits post-ship workflows requiring changelog refinement, version management, and architectural diagram validation. Use it when manual overhead of keeping documentation in sync with code changes becomes unsustainable.