document-release

Scan project diffs and update documentation files to reflect shipped changes.

Updated Mar 22, 2026
One-click install
npx skills add https://github.com/jm199seo/lostark-accessory-viewer --skill document-release-jm199seo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/jm199seo/lostark-accessory-viewer/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/jm199seo/lostark-accessory-viewer --skill document-release-jm199seo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation drift is common. This skill reads project diffs after shipping, updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped, polishes CHANGELOG language, cleans up TODOS, and can bump VERSION when appropriate.

Core Features & Use Cases

  • Auto-sync docs to reflect shipped changes across multiple files.
  • Polish CHANGELOG wording and tidy TODOS for clarity.
  • Proactively suggest and perform a version bump when changes warrant it.
  • Trigger after PR merges or code shipments to keep docs aligned with reality.

Quick Start

Run the document-release skill after a PR ships to align documentation with the latest changes.

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 documentation after a PR merge?

To automatically update documentation after a PR merge, you can use a post-ship docs automation skill that scans project diffs and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to reflect the shipped changes with minimal manual edits.

What is post-ship documentation drift and how do I prevent it?

Post-ship documentation drift occurs when shipped code changes are not reflected in project docs. Prevent it by running an automated diff-analysis process after code shipments to sync guidance, polish changelog language, and clean up TODOS across project files.

Can I automatically bump the version in my documentation when changes qualify?

Yes, you can automatically bump the version in your documentation. Automated post-ship docs tools can proactively suggest and perform a version bump in your project files when the scanned code diffs warrant a version increment.

How do I keep my CHANGELOG and TODOS aligned with shipped code changes?

To keep your CHANGELOG and TODOS aligned with shipped code changes, trigger an automated documentation sync process after PR merges. This polishes changelog wording, tidies TODOS for clarity, and ensures frontmatter-driven metadata is respected.

Does automated docs-sync respect existing frontmatter-driven metadata?

Yes, automated docs-sync processes can respect existing frontmatter-driven metadata. When scanning diffs and updating project files like CLAUDE.md and README, the tool enforces that your established frontmatter metadata rules are maintained.

When should I run a documentation alignment process for my codebase?

You should run a documentation alignment process immediately after PR merges or code shipments. Triggering the diff-analysis at these points ensures your README, ARCHITECTURE, and CONTRIBUTING files reflect reality before further development occurs.