skills.rest
caraseli02
caraseli02COMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Automates post-ship documentation updates by reading project docs and cross-referencing diffs.

Updated Aug 23, 2026
Search Tags:#automation#changelog#versioning#documentation#diff#post-ship
One-click install
npx skills add https://github.com/caraseli02/MoldovaDirect --skill document-release-caraseli02
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/caraseli02/MoldovaDirect/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/caraseli02/MoldovaDirect --skill document-release-caraseli02

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation updates are automated: it reads project docs, cross-references diffs, and updates core files to reflect shipped changes. It polishes the CHANGELOG, tidies TODOS, and can bump the VERSION when appropriate.

Core Features & Use Cases

  • Updates README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to match shipped changes.
  • Reconciles diffs across documentation to keep messages consistent and accurate.
  • Polishes CHANGELOG voice, tidies TODOS, and optionally bumps the project VERSION after a release.

Quick Start

Run the document-release workflow after a PR is shipped to refresh and synchronize all project documentation.

Frequently Asked Questions about document-release

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automate post-ship documentation updates after a release?▼

Automate post-ship documentation updates by running a workflow that reads project diffs and updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE files to accurately reflect shipped changes.

What is the best way to keep my CHANGELOG consistent with shipped code diffs?▼

Keeping your CHANGELOG consistent involves cross-referencing code diffs against existing documentation and polishing the changelog voice to accurately narrate what shipped in the latest release.

How do I synchronize README and ARCHITECTURE files with recent code changes?▼

Synchronize README and ARCHITECTURE files by cross-referencing project diffs against current documentation content and applying updates to keep the architecture descriptions consistent with shipped changes.

When should I run a documentation update workflow for my project?▼

Run a documentation update workflow immediately after a PR is shipped to refresh and synchronize all project documentation, ensuring your changelog, TODOS, and architectural docs reflect the latest release.

Related Skills

Explore More Content & Communication Skills→
shysssthanhtrishysssthanhtri

conventional-commit

Generate Conventional Commit messages from staged Git diffs with Jira ticket IDs.

Community
Intermediate
FFOO6866FFOO6866

deployment-git

Coordinate Git workflows and CI/CD pipelines to publish multi-package SDKs to PyPI.

Community
Advanced
rioX432rioX432
2

update-docs

Audit and update Markdown documentation to match repository structure and git history.

Community
Advanced
akillnessakillness
40

api-documentation

Generate API documentation from OpenAPI specs or code annotations.

Community
Advanced