skills.rest
him55710-sudo
him55710-sudoCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README, ARCHITECTURE, and CLAUDE.md entries from ship diffs.

Updated Mar 19, 2026
Search Tags:#documentation#diff#CHANGELOG#CLAUDE#docs-sync#post-ship
One-click install
npx skills add https://github.com/him55710-sudo/uni-foli --skill document-release-him55710-sudo
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/him55710-sudo/uni-foli/tree/main/.agents/skills/gstack-document-release
Command: npx skills add https://github.com/him55710-sudo/uni-foli --skill document-release-him55710-sudo

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After a ship, docs often drift from the actual changes. This Skill automatically updates README, ARCHITECTURE, CLAUDE.md, and related docs to reflect what shipped, keeping the project narrative accurate.

Core Features & Use Cases

  • Automatically scan diffs from the ship, identify affected docs, and apply precise edits to keep documentation aligned with code.
  • Polish CHANGELOG voice and ensure consistency across architecture and contributing guides without overwriting intent.
  • Optionally bump version gates or guide follow-up updates in related docs as part of the post-ship workflow.

Quick Start

Review the diff and run the document-release workflow to align docs with shipped 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 shipping a release?▼

To update documentation after a release, this Skill scans project diffs and applies targeted factual edits to README, ARCHITECTURE, and CLAUDE.md files, ensuring post-ship docs accurately reflect the shipped changes.

What is the best way to keep a CHANGELOG aligned with code diffs?▼

The best way to keep a CHANGELOG aligned is polishing its notes based on cross-referenced diffs during the post-ship workflow, ensuring consistent voice while preserving the original author intent without overwriting context.

Does this docs-sync process modify my project files safely?▼

Yes, the docs-sync process modifies files safely by enforcing factual edits only, respecting versioning, and recording a telemetry footprint for the ship workflow without overwriting your original author intent.

Can I use this to bump version gates in my architecture docs?▼

Yes, you can use this to optionally bump version gates or guide follow-up updates in related docs like ARCHITECTURE and contributing guides as part of the post-ship workflow.

Why does my project documentation drift after a ship?▼

Project documentation drifts after a ship because manual updates often lag behind actual code changes; this Skill prevents drift by automatically cross-referencing diffs and applying precise edits to affected docs.

Related Skills

Explore More Content & Communication Skills→
dogeareddogeared

document-release

Align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped code changes.

Community
Intermediate
agatxagatx
5

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after releases.

Community
Advanced
GrassHopper42GrassHopper42

document-release

Automates documentation updates after release using Git diff analysis and Markdown files.

Community
Advanced
zhu637882-stackzhu637882-stack

document-release

Update project docs and changelog to reflect a shipped diff.

Community
Advanced