document-release

Update project documentation to match code changes after release.

Updated Mar 13, 2026
One-click install
npx skills add https://github.com/AkbarDevop/ayah-studio --skill document-release-akbardevop
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/AkbarDevop/ayah-studio/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/AkbarDevop/ayah-studio --skill document-release-akbardevop

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill streamlines the process of updating project documentation, ensuring accuracy and consistency after code changes.

Core Features & Use Cases

  • Automated Documentation Updates: Reads and updates documentation based on code changes.
  • Documentation Synchronization: Ensures README, Architecture, and other project documents are in sync with the shipped code.
  • Change Tracking: Tracks changes made during development and reflects them in the documentation.
  • Use Case: After deploying a new feature, this Skill automatically updates the relevant documentation, including the CHANGELOG and README files.

Quick Start

Run the 'document-release' skill to update all project documentation after merging your code changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate project documentation updates after shipping code changes?

To automate documentation updates, this Skill compares your project documents directly with code changes and updates them accordingly. It reads your codebase to ensure README and CHANGELOG files are synchronized with the shipped code.

What is the best way to keep README and CHANGELOG files in sync with a shipped codebase?

Keeping README and CHANGELOG files in sync is achieved by tracking development changes and reflecting them in the documentation. This Skill detects codebase modifications and applies the corresponding updates to your project documents.

Do I need to grant codebase access for automated document maintenance?

Yes, you need to grant codebase access for automated document maintenance. The Skill requires access to your project files and codebase to compare documents against code changes and update them directly.

How does change tracking work for software project documentation?

Change tracking for software project documentation works by comparing project documents with code changes after deployment. It identifies discrepancies between your codebase and documentation, then automatically applies the necessary updates.

When should I run automated documentation synchronization for my project?

You should run automated documentation synchronization immediately after deploying a new feature or merging code changes. This ensures your project documents accurately reflect the latest shipped code without requiring manual updates.