skills.rest
TobiasPerry
TobiasPerryCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Read diffs and update core project documentation after shipping.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automatically updates and synchronizes project documentation after code changes and shipping events by reading the diff and updating core docs (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md), polishing CHANGELOG entries, and tidying TODOS, with optional version bumps.

Core Features & Use Cases

  • Post-ship documentation alignment: reads diffs and updates core docs to reflect what shipped.
  • CHANGELOG polishing and TODOS cleanup: preserves historical entries while improving wording and removing stale items.
  • Version bump guidance: suggests and applies version bumps when changes warrant a new release.

Quick Start

Run the document-release workflow on the feature branch after shipping to automatically sync all project docs.

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 project documentation after a code release?▼

To update project documentation after a code release, you can read the latest diffs and apply those changes to core docs like README, ARCHITECTURE, and CONTRIBUTING so everything reflects the shipped code.

What is the best way to keep README and ARCHITECTURE docs in sync with merged PRs?▼

Keeping README and ARCHITECTURE docs in sync with merged PRs involves reading post-merge diffs and updating the relevant core documentation sections to accurately reflect the newly shipped code changes.

How does changelog polishing work when synchronizing post-ship documentation?▼

Changelog polishing works by preserving historical entries while improving the wording of new changes and removing stale TODOS, ensuring the changelog accurately reflects shipped updates without losing prior history.

Can I trigger an automated version bump when updating docs for a new release?▼

Yes, you can trigger an automated version bump when updating docs for a new release. The process suggests and applies version bumps automatically when the shipped changes warrant a new release version.

Does post-ship documentation alignment work with CLAUDE.md files?▼

Yes, post-ship documentation alignment works with CLAUDE.md files. The process reads recent diffs and updates CLAUDE.md alongside README, ARCHITECTURE, and CONTRIBUTING to capture code changes in the right places.

When should I use an automated documentation sync workflow for shipped code?▼

You should use an automated documentation sync workflow for shipped code during post-ship workflows, PR merges, and doc polishing to ensure core project files accurately reflect the latest changes without manual intervention.

Related Skills

Explore More Software Engineering Skills→
fray-cloudfray-cloud

document-release

Automates updating project docs after inspecting committed code changes.

Community
Advanced
kasperjungekasperjunge
450

make-release

Automate PyPI releases via GitHub Actions with version bumps and changelog updates.

Community
Advanced
sandrusidoltst-a11ysandrusidoltst-a11y

validation

Run linting, type checking, and targeted tests for FitPal code changes.

Community
Advanced
MFS-codeMFS-code
8

document-release

Audit markdown documentation against code diffs and update release notes.

Community
Advanced