skills.rest
Jaykaijack
JaykaijackCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation to reflect shipped changes after PR creation.

Updated Mar 15, 2026
Search Tags:#documentation#CHANGELOG#docs-sync#post-ship#VERSION
One-click install
npx skills add https://github.com/Jaykaijack/openclaw-backup --skill document-release-jaykaijack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Jaykaijack/openclaw-backup/tree/main/skills/gstack/document-release
Command: npx skills add https://github.com/Jaykaijack/openclaw-backup --skill document-release-jaykaijack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation is often out of date. This Skill reads the project's docs, compares them to what shipped, and updates key files to reflect released changes, ensuring consistency and clarity.

Core Features & Use Cases

  • Read all project docs and cross-reference diffs to identify discrepancies between shipped changes and documentation.
  • Update README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what was shipped.
  • Polish CHANGELOG voice, clean up TODOS, and optionally bump VERSION when requested.
  • Proactively suggest documentation updates after a PR is merged or code is shipped.

Quick Start

Ask me to update the docs after a PR merge and I will run the post-ship documentation sync.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I keep documentation in sync after shipping a release?▼

Post-ship documentation sync reads project docs, cross-references shipped code diffs, and updates README.md, ARCHITECTURE.md, and CLAUDE.md to accurately reflect the newly released changes.

How do I update README and CHANGELOG to match merged PRs?▼

Updating README and CHANGELOG to match merged PRs involves comparing the merged code diffs against existing docs, polishing the CHANGELOG voice, cleaning up TODOS, and rewriting stale sections to ensure consistency and clarity.

When should I run a post-ship documentation update in my workflow?▼

You should run a post-ship documentation update after PR creation but before the final merge, allowing the process to proactively suggest doc parity adjustments and cross-reference changes before the code is officially shipped.

Does post-ship doc synchronization work with CLAUDE and gstack projects?▼

Post-ship doc synchronization applies directly to projects using CLAUDE and gstack, maintaining doc parity and consistency by updating CONTRIBUTING.md and VERSION files after releases.

What is the best way to automate version bumps and TODO cleanup after a release?▼

The best way to automate version bumps and TODO cleanup is to run a post-ship documentation sync that optionally bumps the VERSION file and cleans up TODOS while polishing the CHANGELOG tone to reflect what shipped.

Can I proactively suggest documentation updates before merging a pull request?▼

Yes, you can proactively suggest documentation updates before merging by running the post-ship sync process after PR creation, which identifies discrepancies between shipped changes and current docs to recommend necessary adjustments.

Related Skills

Explore More Content & Communication Skills→
TimHL5TimHL5

document-release

Align README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md with shipped changes.

Community
Advanced
Conceptual-MachinesConceptual-Machines
195

release

Create and push a v-prefixed git tag on the main branch.

Official
Intermediate
AlejandroFiginiAlejandroFigini

sync-gbrain

Refresh the gbrain brain-index and agent search guidance in CLAUDE.md.

Community
Advanced
AstrumonAstrumon

changelog-generator

Generate Keep a Changelog entries from Conventional Commits history.

Community
Intermediate