skills.rest
howdeploy
howdeployCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Synchronize project documentation with released code by reading diffs and updating markdown files.

15|1|Updated Apr 4, 2026
Search Tags:#documentation#claude.md#README#CHANGELOG#docs-sync#post-ship
One-click install
npx skills add https://github.com/howdeploy/NekoFree --skill document-release-howdeploy
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/howdeploy/NekoFree/tree/main/skills/document-release
Command: npx skills add https://github.com/howdeploy/NekoFree --skill document-release-howdeploy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from the shipped code. This skill reads project docs, cross-references differences, and updates key docs to reflect what was shipped, polishing tone and removing gaps.

Core Features & Use Cases

  • Reads project docs and diffs to identify drift.
  • Updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to align with shipped changes.
  • Polishes CHANGELOG language, cleans up TODOS, and can bump VERSION when appropriate.

Quick Start

Use after a PR is merged or code is shipped to bring docs in sync with the release.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I sync documentation with released code changes after a merge?▼

To sync documentation with released code, you can read project diffs and update markdown files like README and ARCHITECTURE to reflect shipped changes. This aligns post-ship docs with the actual codebase.

What is the best way to update CLAUDE.md and CHANGELOG after shipping code?▼

Updating CLAUDE.md and CHANGELOG post-ship involves cross-referencing code diffs with existing docs, polishing the language, and removing outdated gaps to preserve project tone and accuracy.

Why does my project documentation drift from the shipped code?▼

Project documentation drifts from shipped code when updates are not synchronized post-release. Reading repo diffs and modifying markdown files ensures documentation reflects the latest changes.

Can I automatically bump the version and clean up TODOS when syncing docs?▼

Yes, you can clean up TODOS and bump the VERSION when appropriate as part of synchronizing post-ship documentation, ensuring the project state remains consistent across files.

Does this docs-sync approach work for CONTRIBUTING and ARCHITECTURE files?▼

Yes, this docs-sync approach targets CONTRIBUTING and ARCHITECTURE files alongside README and CLAUDE.md, ensuring all key project documentation aligns with the shipped changes.

When do I need to update post-ship documentation?▼

You need to update post-ship documentation immediately after a PR is merged or code is shipped, ensuring your README, CHANGELOG, and project docs accurately reflect the new release state.

Related Skills

Explore More Software Engineering Skills→
robertzengcnrobertzengcn

document-release

Synchronize project documentation with shipped code after PR merges.

Community
Advanced
t0labt0lab
2

release

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

Official
Advanced
olivermorgan2olivermorgan2

adr-writer

Draft standardized Architectural Decision Records as markdown files in a git repository.

Community
Advanced
JongsixJongsix

moai-docs-generation

Generate technical documentation from source code and API definitions.

Community
Advanced