document-release

Name: document-release
Availability: InStock
Author: nuurpro

Automate post-ship documentation updates by scanning diffs and revising key project files.

1|1|Updated Mar 28, 2026

Search Tags:#automation #documentation #diff #CHANGELOG #docs-update #post-ship

Ready to run

npx skills add https://github.com/nuurpro/Converza_ai --skill document-release-nuurpro

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/nuurpro/Converza_ai/tree/main/.claude/skills/document-release
Command: npx skills add https://github.com/nuurpro/Converza_ai --skill document-release-nuurpro

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates the post-ship documentation update process. It scans changed docs, cross-references the diff, and updates READMEs, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what shipped.

Core Features & Use Cases

Documentation alignment: keep READMEs and architecture notes in sync with shipped changes.
CHANGELOG polish: refine release notes and clear TODOS, preparing for the next PR.
Auto-version hinting: optionally bump VERSION when changes warrant it and prompt for confirmation.

Quick Start

Tell me to run the post-ship documentation update workflow to refresh docs after a release.

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 shipping a release?▼

You can automate post-ship documentation updates by scanning changed docs, cross-referencing diffs, and updating READMEs, ARCHITECTURE.md, CONTRIBUTING.md, and CLAUDE.md to reflect what shipped.

How do I keep my README and architecture notes in sync with merged changes?▼

To keep READMEs and architecture notes in sync with merged changes, run the post-ship documentation update workflow to scan diffs and apply updates across your project documentation.

What is the best way to polish CHANGELOG voice and clean up TODOs after a PR?▼

The best way to polish CHANGELOG voice and clear TODOs after a PR is to run an automated post-ship workflow that refines release notes and prepares documentation for the next PR.

Can I automatically bump the VERSION file when shipping changes?▼

Yes, you can optionally bump VERSION when changes warrant it; the workflow prompts for confirmation during the post-ship documentation update process.

Does this documentation update workflow work without external dependencies?▼

Yes, the workflow operates without external dependencies, relying on built-in Bash, Read, Write, Edit, Grep, Glob, and AskUserQuestion tools to maintain a controlled, auditable process.