document-release

Update project documentation to match shipped code changes.

Updated May 22, 2026
One-click install
npx skills add https://github.com/shekerkamma/peopletech-marketplace --skill document-release-shekerkamma
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/shekerkamma/peopletech-marketplace/tree/main/plugins/gstack/document-release
Command: npx skills add https://github.com/shekerkamma/peopletech-marketplace --skill document-release-shekerkamma

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After code is shipped, project documentation like READMEs, CHANGELOGs, and architecture guides often fall out of sync with the actual shipped features, causing confusion for team members and new contributors. This Skill eliminates the tedious manual work of updating all project docs to match what was actually deployed.

Core Features & Use Cases

  • Automated Doc Alignment: Cross-references recent code diffs to update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect shipped changes.
  • CHANGELOG Polish & Cleanup: Refines the voice of CHANGELOG entries and removes outdated TODO comments left in documentation.
  • Optional Version Bumping: Automatically updates the project VERSION file to match the new release if needed.
  • Use Case: After merging a PR that adds a new user authentication flow, run this Skill to automatically update the README to document the new flow, add the change to the CHANGELOG, and remove any outdated TODO comments about auth in the project docs.

Quick Start

Use the document-release skill to update all project documentation to match the changes from your most recent shipped code PR.

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 README and CHANGELOG files after a code deployment?

To automatically update README and CHANGELOG files after a code deployment, you can use a post-ship documentation sync tool that reads code diffs and cross-references existing docs to align content with shipped features.

What is the best way to keep project documentation in sync with shipped code changes?

Keeping project documentation in sync with shipped code changes is best achieved by automating doc alignment, which cross-references recent code diffs to update README, architecture, and configuration files without manual intervention.

Can I automatically remove outdated TODO comments from documentation after merging a PR?

Yes, you can automatically remove outdated TODO comments from documentation after merging a PR by running a post-ship doc cleanup process that polishes changelog entries and cleans up stale project docs.

Does automated documentation sync support optional version bumping for new releases?

Automated documentation sync does support optional version bumping, allowing you to automatically update the project VERSION file to match the new release alongside synchronizing your standard project docs.

When do I need to run post-ship documentation updates for my software engineering workflow?

You need to run post-ship documentation updates in your software engineering workflow whenever deployed code changes introduce new features, requiring synchronization of architecture guides and configuration files to prevent team confusion.