skills.rest
I194
I194COMMUNITY
Explore all skills by this author →
GitHub

document-release

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

9|3|Updated Jan 29, 2022
Search Tags:#changelog#versioning#documentation#readme#diff#post-ship
One-click install
npx skills add https://github.com/I194/PMTools_2.0 --skill document-release-i194
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/I194/PMTools_2.0/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/I194/PMTools_2.0 --skill document-release-i194

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are tedious and error-prone when diffs across code and docs drift from shipped changes. This Skill automates reading diffs and updating key docs to reflect what shipped, while polishing CHANGELOG language and tidying TODOS.

Core Features & Use Cases

  • Reads project changes and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to align with shipped content.
  • Polishes CHANGELOG wording, cleans up TODOS, and optionally bumps VERSION to reflect new releases.
  • Provides a proactive suggestion mechanism after a PR or release to keep docs in sync without manual intervention.

Quick Start

Run the document-release workflow after a ship event to align docs 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 shipping a new release?▼

You can align post-ship docs by running the workflow after a ship event; it scans project diffs and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.

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

Syncing a CHANGELOG with code diffs is handled by scanning project changes, polishing the CHANGELOG wording, cleaning up TODOS, and optionally bumping the VERSION file to reflect new releases.

How do I keep README and ARCHITECTURE docs aligned with shipped code changes?▼

Keeping README and ARCHITECTURE docs aligned with shipped code changes is achieved by applying precise markdown updates based on the project diff, ensuring core documentation matches the latest shipped content.

Does this documentation sync tool work without external dependencies?▼

Yes, this documentation sync tool works without external dependencies, relying solely on its internal logic to scan project diffs and apply markdown updates to repository files.

When should I use an automated post-ship documentation workflow?▼

You should use an automated post-ship documentation workflow after a PR or release event to proactively keep docs in sync without manual intervention, preventing code and documentation drift.

Related Skills

Explore More Content & Communication Skills→
BradliebsBradliebs

document-release

Update project documentation files to reflect shipped code changes.

Community
Advanced
adriannoesadriannoes
46

update-changelog

Parse repository tags and commit history to generate markdown changelog entries.

Community
Basic
CarbeneAICarbeneAI
9

document-release

Update repository documentation files from git diffs after code merges.

Community
Advanced
mattothomasmattothomas

document-release

Align project documentation with shipped changes after merges.

Community
Advanced