skills.rest
kitfunso
kitfunsoCOMMUNITY
Explore all skills by this author →
Website𝕏@keithso27GitHub

document-release

Sync and polish project documentation after code ships.

Updated Apr 9, 2026
Search Tags:#automation#versioning#documentation#CHANGELOG#pull-request#post-ship
One-click install
npx skills add https://github.com/kitfunso/omniskill --skill document-release-kitfunso
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/kitfunso/omniskill/tree/main/skills/document-release
Command: npx skills add https://github.com/kitfunso/omniskill --skill document-release-kitfunso

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Automates updating project documentation after shipping changes by syncing docs to reflect what shipped and improving phrasing across key files (README, ARCHITECTURE, CONTRIBUTING, CLAUDE.md) and optional TODOS/polish of CHANGELOG.

Core Features & Use Cases

  • Auto-synchronize READMEs and policy docs (README/ARCHITECTURE/CONTRIBUTING/CLAUDE.md) with shipped changes.
  • Polish the CHANGELOG wording and clean up TODOS.
  • Optionally bump VERSION and surface doc updates for PR bodies.

Quick Start

Run this skill after shipping changes to automatically update documentation.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate documentation updates after a pull request merges?▼

Automating post-ship documentation updates syncs project files like README, ARCHITECTURE, and CLAUDE.md to reflect shipped changes. It safely edits relevant docs and bumps VERSION when appropriate after a PR merge.

What is the best way to polish a CHANGELOG after shipping code?▼

Polishing a CHANGELOG after shipping involves cleaning up TODOS and improving wording to accurately reflect the merged changes. This ensures the project history remains clear and synchronized with the actual code updates.

Can I automatically update my README and CONTRIBUTING files when code ships?▼

Yes, automatically updating README and CONTRIBUTING files when code ships synchronizes policy docs with the latest changes. This ensures guidelines and overviews accurately reflect the current state of the repository.

How does version management work with post-ship documentation automation?▼

Post-ship documentation automation handles version management by optionally bumping the VERSION file when appropriate. It ensures version tracking stays consistent with the merged code changes and repository state.

Do I need repository access to sync project docs after a pull request?▼

Yes, syncing project docs after a pull request requires repository access to perform safe file edits. This access allows the automation to update README, ARCHITECTURE, and other documentation files accurately.

When should I update CLAUDE.md and project documentation after shipping?▼

You should update CLAUDE.md and project documentation immediately after shipping changes to ensure docs reflect what shipped. This keeps architectural context and contribution guidelines aligned with the latest codebase.

Related Skills

Explore More Content & Communication Skills→
bajajvinamrbajajvinamr

document-release

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

Community
Intermediate
EhsaanArkEhsaanArk

ship

Merge base branch, run tests, bump version, and create a pull request.

Community
Advanced
adityasingh2400adityasingh2400
2

document-release

Cross-reference shipped diffs and update Markdown project documentation.

Community
Advanced
chriswesttchriswestt

document-release

Update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md after shipping changes.

Community
Advanced