document-release

Synchronize README, architecture, and changelog files after code deployment.

Updated Jun 5, 2026

Search Tags:#automation #changelog #documentation #maintenance #release #sync

Ready to run

npx skills add https://github.com/smarmen86/claude-code-kit --skill document-release-smarmen86

💬 Prompt for ChatGPT / Claude Chat▼

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

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This skill eliminates documentation drift and post-ship manual labor by automatically synchronizing project documentation with the latest code changes and release state.

Core Features & Use Cases

Automated Sync: Updates README, ARCHITECTURE, and CLAUDE.md files to reflect the current codebase state.
Quality Assurance: Detects architecture diagram drift, cleans up TODOs, and polishes CHANGELOG entries using a sell-test rubric.
Use Case: After merging a major feature branch, use this skill to ensure your documentation, versioning, and architecture diagrams are perfectly aligned with the new code before finalizing the release.

Quick Start

Invoke the document-release skill to sync all project documentation and update the changelog after your latest code ship.

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 code release?▼

Automating documentation updates after a code release requires synchronizing project files like README and CHANGELOG with the latest deployment state to prevent documentation drift. This skill handles that by integrating git and file system operations to automatically align docs post-ship.

What is documentation drift and how do I prevent it after merging a feature branch?▼

Documentation drift happens when project docs become outdated relative to the codebase. You can prevent it after merging a feature branch by running an automated synchronization process that updates architecture diagrams, README, and CLAUDE.md files to reflect the current deployed state.

Can I automatically sync my CHANGELOG and architecture diagrams before finalizing a release?▼

Yes, you can automatically sync your CHANGELOG and architecture diagrams before finalizing a release. The skill detects architecture diagram drift, cleans up TODOs, and polishes CHANGELOG entries using a sell-test rubric to ensure everything is perfectly aligned with the new code.

Does automated changelog maintenance work without external dependencies?▼

Yes, automated changelog maintenance works without external dependencies. The skill operates using integrated git and file system operations to manage versioning and documentation sync, requiring no additional external libraries or packages to function within your software development workflow.

What is the best way to reduce documentation debt in a software development workflow?▼

The best way to reduce documentation debt in a software development workflow is to automate post-ship synchronization of README, ARCHITECTURE, and CLAUDE.md files. This ensures documentation consistently matches the deployed codebase without adding manual labor.

When should I not use automated documentation synchronization?▼

You should not use automated documentation synchronization if your project lacks a git repository or standard file system structure, as the skill relies on integrated git and file system operations to detect drift and update configuration files during the release process.