skills.rest
Yaugourt
YaugourtCOMMUNITY
Explore all skills by this author →
𝕏@YaugourtGitHub

document-release

Update project documentation to match shipped code changes.

2|2|Updated Dec 1, 2024
Search Tags:#automation#documentation#docs#CLAUDE.md#CHANGELOG#gstack#post-ship
One-click install
npx skills add https://github.com/Yaugourt/LiquidTerminal_Back --skill document-release-yaugourt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Yaugourt/LiquidTerminal_Back/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/Yaugourt/LiquidTerminal_Back --skill document-release-yaugourt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps project documentation in sync with what ships, preventing drift between code changes and the docs that describe them.

Core Features & Use Cases

  • Cross-reference ship diffs and automatically update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect shipped changes.
  • Polish CHANGELOG voice, remove stale TODOS, and optionally bump the VERSION after release.
  • Serve as a repeatable post-ship doc workflow that reduces manual editing and ensures consistent narration across docs.

Quick Start

Document-release after ship to align docs with the latest code and PR outcomes.

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 ship or PR merge?▼

Automate post-ship documentation updates by scanning project docs and aligning README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md with what shipped. It cross-references diffs and modifies files to reflect the latest code changes automatically.

What is the best way to keep CHANGELOG and README aligned with shipped code changes?▼

The best way to keep CHANGELOG and README aligned is to cross-reference ship diffs and automatically polish the CHANGELOG voice while updating documentation to reflect the shipped changes. This reduces manual editing and prevents documentation drift.

Can I automatically bump the VERSION and clean up stale TODOS after a release?▼

Yes, you can automatically bump the VERSION and clean up stale TODOS after a release. The workflow queries user decisions during version bumps and removes outdated TODO entries to ensure consistent project narration.

Do I need specific tools to scan diffs and update CLAUDE.md automatically?▼

Yes, you need Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion tools to scan diffs, modify files, and query user decisions. These tools allow the workflow to read code changes and update CLAUDE.md accordingly.

When should I run a post-ship documentation workflow to prevent doc drift?▼

You should run a post-ship documentation workflow immediately after a PR is merged or code is shipped. Operating at this stage ensures your project documentation stays synchronized with the actual codebase and prevents silent drift.

How does cross-referencing ship diffs improve project documentation consistency?▼

Cross-referencing ship diffs improves project documentation consistency by automatically identifying code changes and propagating them across README, ARCHITECTURE, and CONTRIBUTING files. This ensures all docs accurately narrate the latest release outcomes without manual cross-checking.

Related Skills

Explore More Content & Communication Skills→
vib795vib795

document-release

Sync shipped code changes into repository documentation files.

Community
Advanced
marcel-heinzmarcel-heinz
4

release

Coordinate ClawCity release workflows with version bumps, changelog updates, git tagging, and GitHub releases.

Community
Advanced
shekerkammashekerkamma

land-and-deploy

Merge PRs, wait for CI/CD completion, and verify production via canary checks.

Community
Advanced
TumeloRamaphosaTumeloRamaphosa

document-release

Audit project docs against code diffs and build a Diataxis coverage map.

Community
Advanced