skills.rest
vnmoorthy
vnmoorthyCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation files to reflect shipped changes.

2|1|Updated Mar 5, 2026
Search Tags:#automation#versioning#documentation#diffing#readme-update#post-ship
One-click install
npx skills add https://github.com/vnmoorthy/Skylog --skill document-release-vnmoorthy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/vnmoorthy/Skylog/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/vnmoorthy/Skylog --skill document-release-vnmoorthy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation update. Reads all project docs, cross-references the diff, updates README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md to match what shipped, polishes CHANGELOG voice, cleans up TODOS, and optionally bumps VERSION. Use when asked to "update the docs", "sync documentation", or "post-ship docs".

Core Features & Use Cases

  • Reads all project docs and cross-references changes to keep docs in sync with shipped code.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect the shipped changes.
  • Polishes CHANGELOG language, cleans up TODOS, and can bump the VERSION when appropriate.

Quick Start

Run the document-release skill after shipping to synchronize 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 project documentation after a release?▼

To automate post-ship documentation updates, you can run a process that cross-references the release diff and updates core project files like README and ARCHITECTURE to match the shipped code changes.

What is the best way to keep my README and CONTRIBUTING files in sync with shipped code?▼

Keeping documentation in sync with shipped code involves cross-referencing project changes against existing docs and applying targeted edits to files like README and CONTRIBUTING to accurately reflect the new state.

Can I automatically polish CHANGELOG entries and clean up TODOs after shipping?▼

Yes, you can polish CHANGELOG entries and clean up TODOs after shipping by applying an automated documentation update process that refines language and resolves completed tasks during the post-ship sync.

Does post-ship documentation update work for both PRs and full releases?▼

Post-ship documentation updates apply to both PRs and full releases, reading the changes from the shipped event to synchronize project documentation and optionally bump the VERSION file.

Which project files should I target when syncing documentation after a release?▼

When syncing documentation after a release, you should target core project files including README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to ensure comprehensive coverage of the shipped changes.

Related Skills

Explore More Content & Communication Skills→
LukasStricklerLukasStrickler
4

docs-check

Analyze git diffs to identify required documentation updates after code changes.

Community
Basic
ousiassousiass

release

Generate bilingual changelogs, version tags, and GitHub release notes.

Community
Advanced
huichenhuichen

document-release

Update project documentation files after code ships.

Community
Advanced
evanfang0054evanfang0054

documentation-sync

Automates project documentation updates from code changes.

Community
Advanced