skills.rest
umairinayat
umairinayatCOMMUNITY
Explore all skills by this author →
𝕏@umairstuffGitHub

document-release

Update README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md, CHANGELOGs, TODOs, and optionally VERSION after a release.

2|Updated Mar 16, 2026
Search Tags:#automation#versioning#documentation#diff#docs#polish
One-click install
npx skills add https://github.com/umairinayat/AgentTrace --skill document-release-umairinayat
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/umairinayat/AgentTrace/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/umairinayat/AgentTrace --skill document-release-umairinayat

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are error-prone and time-consuming. This Skill automatically aligns shipped changes across core project docs by reading diffs and updating key documentation files to reflect what was released, reducing drift and manual toil.

Core Features & Use Cases

  • Automated doc synchronization: scans project docs, cross-references shipped changes, and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped.
  • Changelog polish & TODOS cleanup: refines CHANGELOG voice and cleans up TODOS to remain consistent with the latest release.
  • Version bump governance: optionally bumps the repository VERSION when changes warrant a new release.

Quick Start

Run the document-release process after a release to automatically align docs with the latest 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 automate documentation updates after a release?▼

Automate documentation updates after a release by consuming repository diffs to cross-reference shipped changes and apply safe, file-based edits to core project docs. This reduces manual toil and prevents documentation drift immediately following a version ship.

What is the best way to keep README and ARCHITECTURE docs aligned with shipped changes?▼

Keeping README and ARCHITECTURE docs aligned with shipped changes is done by reading project diffs and automatically applying safe edits to reflect the latest release. This ensures core documentation files accurately mirror the newly deployed project state.

Can I automatically polish CHANGELOG entries and clean up TODOS post-release?▼

Yes, you can polish CHANGELOG entries and clean up TODOS post-release by running an automated process that refines the changelog voice and removes stale tasks. It cross-references repository diffs to ensure documentation remains consistent with the latest release.

Does this documentation automation tool support version bumping in the repository?▼

Yes, the documentation automation tool supports version bumping in the repository. It optionally bumps the repository VERSION file when the analyzed shipped changes warrant a new release, respecting existing versioning and contribution workflows.

How does automated post-ship documentation synchronization handle existing contribution workflows?▼

Automated post-ship documentation synchronization handles existing contribution workflows by applying safe, file-based edits that respect established versioning rules. It reads repository diffs and updates CONTRIBUTING docs without disrupting your current development process.

Related Skills

Explore More Content & Communication Skills→
shihwesleyshihwesley

document-release

Update Markdown documentation and changelog after a release.

Community
Intermediate
JCE-Joshhh77JCE-Joshhh77
16

release-engineering

Automate version bumps, changelog updates, and tag verification across repositories.

Community
Intermediate
ufkesbaufkesba

devsecops-github-audit

Audit GitHub repository workflows and security controls for compliance gaps.

Community
Advanced
agwacomagwacom

avad-document-release

Automate post-ship documentation alignment by updating README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md.

Official
Advanced