skills.rest
jonkiky
jonkikyCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update project documentation to reflect shipped changes after a merge.

Updated Apr 2, 2026
Search Tags:#automation#documentation#diff#contributing#CLAUDE.md#CHANGELOG#version-bump
One-click install
npx skills add https://github.com/jonkiky/ccdi-federation-ai --skill document-release-jonkiky
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/jonkiky/ccdi-federation-ai/tree/main/.agents/document-release
Command: npx skills add https://github.com/jonkiky/ccdi-federation-ai --skill document-release-jonkiky

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Post-ship documentation often lags behind shipped changes. This Skill reads project docs, cross-references the diff, and updates READMEs, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to reflect what shipped.

Core Features & Use Cases

  • Automated alignment of documentation with the latest release, ensuring READMEs and architectural notes stay accurate.
  • CHANGELOG polishing, TODOS cleanup, and optional version bump to reflect new shipping.
  • Triggered after PR merges or code shipping, or when explicitly asked to "update the docs" or "sync documentation".

Quick Start

Automatically update and polish project documentation after shipping to reflect 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 documentation after a code release?▼

Automated documentation syncing cross-references the latest git diff to align READMEs, ARCHITECTURE, and CONTRIBUTING files with newly shipped changes, preventing manual post-release updates.

What is the best way to keep a CHANGELOG and CLAUDE.md updated after merging a PR?▼

Keeping a CHANGELOG and CLAUDE.md updated after a PR merge involves reading project docs, polishing the changelog voice, and reflecting the shipped diff in your architectural notes to ensure consistency.

How do I sync project documentation with the latest version bump and diff?▼

You can sync project documentation with the latest version bump by cross-referencing the diff, cleaning up TODOs, and applying an optional version bump to reflect the new shipping changes.

Does automated documentation syncing work without external dependencies?▼

Yes, automated documentation syncing can work without external dependencies, using built-in scripts and references to align your READMEs and architectural notes after code is shipped.

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

You should run a post-ship documentation update immediately after a PR is merged or code is shipped, or whenever you need to sync documentation and clean up TODOs to reflect recent changes.

Related Skills

Explore More Content & Communication Skills→
rcrespodevrcrespodev

living-docs

Generates Markdown documentation from git diffs with Obsidian-compatible YAML frontmatter.

Community
Advanced
t0labt0lab
2

release

Analyze Conventional Commits to draft changelogs and create release commits and tags.

Official
Advanced
catlog22catlog22
511

quality-sync

Trace git diffs to regenerate affected .workflow documentation entries.

Community
Advanced
Lands-1203Lands-1203
40

f2s-doc-arch

Generate project architecture description drafts from documentation or code.

Community
Intermediate