skills.rest
ingoatl
ingoatlCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize project documentation with shipped changes and update core docs.

Updated Aug 27, 2026
Search Tags:#changelog#documentation#release#diff#polish#version-bump
One-click install
npx skills add https://github.com/ingoatl/propertycentral --skill document-release-ingoatl
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/ingoatl/propertycentral/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/ingoatl/propertycentral --skill document-release-ingoatl

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation maintenance is tedious and error-prone. This skill automates syncing release docs across the project, reconciling diffs and updating core docs.

Core Features & Use Cases

  • Synchronizes READMEs, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect shipped changes.
  • Polishes CHANGELOG language, cleans up TODOS, and can optionally bump VERSION.
  • Works after a PR is merged or code is shipped, to keep docs current and consistent.

Quick Start

Run the document-release skill after shipping to automatically synchronize and polish release docs across the project.

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 README and CHANGELOG after shipping code?▼

To update documentation after shipping, you can synchronize files by diffing shipped changes against existing docs and applying patches to README, ARCHITECTURE, and CHANGELOG to reflect the current state.

What is the best way to polish changelog language and clean up TODOs post-merge?▼

Polishing changelog language and cleaning up TODOs post-merge involves reading project documentation, cross-referencing recent changes, and editing files to ensure consistent release notes.

Can I automatically bump the VERSION file when syncing release documentation?▼

Yes, you can bump the VERSION file when syncing release documentation. The process can optionally update the version number alongside reconciling diffs and updating core docs like CLAUDE.md.

Does post-ship documentation sync work without adding external dependencies?▼

Yes, post-ship documentation sync works without external dependencies. It operates using built-in file system commands like Bash, Read, Write, Edit, Grep, and Glob to discover files and apply patches.

When should I run an automated documentation update for my project?▼

You should run an automated documentation update after a PR is merged or code is shipped. This ensures project docs remain current and consistent with the latest codebase state.

Why do my README and ARCHITECTURE docs keep falling out of sync after releases?▼

Your README and ARCHITECTURE docs fall out of sync because manual post-ship maintenance is tedious and error-prone. Automating the diff reconciliation process ensures docs accurately reflect shipped changes.

Related Skills

Explore More Content & Communication Skills→
nesihaver-ILnesihaver-IL

update-docs

Update README, API, architecture docs, and changelogs after code changes.

Community
Intermediate
Umbral-BotUmbral-Bot

publication-gatekeeper

Enforce multi-stage human approval for external content publication.

Official
Advanced
tapanshahtapanshah

Codebase Onboarding

Analyze a codebase to generate onboarding documentation in Markdown, Notion, or Confluence.

Community
Advanced
rahmanayonrahmanayon

document-release

Update project documentation to reflect shipped changes and polish changelog voice.

Community
Advanced