document-release

Update project documentation files and report documentation debt after software releases.

Updated Jun 8, 2026
One-click install
npx skills add https://github.com/reomgit/appstore-ss-downloader --skill document-release-reomgit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/reomgit/appstore-ss-downloader/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/reomgit/appstore-ss-downloader --skill document-release-reomgit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Bash, Read, Write, Edit, Grep, Glob, AskUserQuestion, and includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill automates the process of updating project documentation after software shipping, ensuring the latest changes are reflected in all relevant documentation files.

Core Features & Use Cases

  • Documentation Update: Reads all project documentation and cross-references it against the change log.
  • README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md: Updates these files to match the latest shipped code.
  • CHANGELOG Voice Polish: Refines the CHANGELOG voice for clarity and effectiveness.
  • Documentation Debt Reporting: Reports any missing or outdated documentation to the PR body.
  • VERSION Bump Handling: Optionally handles version bumps in the documentation files.

Quick Start

To update project documentation, invoke the document-release skill after code shipping.

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 shipping code?

You can automate documentation updates post-ship by cross-referencing your change log against project files. This process updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files while refining the CHANGELOG to ensure code-to-doc sync.

What is documentation debt and how is it reported?

Documentation debt refers to missing or outdated project documentation. The skill identifies this debt by performing cross-document consistency checks after shipping, then reports any missing or outdated documentation directly to the PR body for tracking.

Can I handle version bumps and CHANGELOG updates together?

Yes, you can handle version bumps and CHANGELOG updates together. The skill optionally handles version bumps in documentation files and polishes the CHANGELOG voice for clarity during the automated post-ship update process.

Does automated documentation maintenance require specific environment tools?

Automated documentation maintenance requires Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion tools for execution. These dependencies support cross-document consistency checks and file updates across README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files.

What is the best way to keep README and ARCHITECTURE files synced with shipped code?

The best way to keep README and ARCHITECTURE files synced is to perform cross-document consistency checks against the change log. This ensures all relevant documentation files match the latest shipped code and automatically highlights remaining documentation debt.