skills.rest
npc-chris
npc-chrisCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Update README, Architecture, Contributing, and Claude.md files after codebase changes.

1|Updated May 8, 2026
Search Tags:#document automation#change detection#version bumping#post-ship update#code-to-document consistency
One-click install
npx skills add https://github.com/npc-chris/dfn-discovery --skill document-release-npc-chris
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/npc-chris/dfn-discovery/tree/main/.agents/skills/gstack/document-release
Command: npx skills add https://github.com/npc-chris/dfn-discovery --skill document-release-npc-chris

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires Bash, Read, Write, Edit, Grep, Glob, AskUserQuestion, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill streamlines the process of updating documentation after a release, ensuring that all project guides are up-to-date and consistent with the shipped product.

Core Features & Use Cases

  • Post-Shipping Documentation Update: Automatically update README, Architecture, Contributing, and Claude.md files based on the codebase changes.
  • Voice and Grammar Consistency: Polishes the CHANGELOG voice and cleans up TODOs to maintain a user-forward and friendly tone.
  • Version Bump Decision: Optionally suggests and handles version bumps in the VERSION file when needed.
  • Cross-Document Consistency: Checks for discrepancies across different documentation files and resolves them.

Quick Start

Run the document-release skill to update your project's documentation post-ship.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I automate post-release documentation updates for a codebase?▼

Automate post-release documentation updates by running a skill that detects codebase changes and modifies README, Architecture, Contributing, and Claude.md files to ensure shipped product accuracy. It ensures all project guides stay consistent with the latest code.

What is the best way to keep CHANGELOG tone consistent after shipping?▼

The best way to keep CHANGELOG tone consistent is to use a documentation automation skill that polishes the changelog voice and cleans up leftover TODOs. This maintains a user-forward and friendly tone across all post-ship updates.

Does document automation work with Bash and Grep for change detection?▼

Yes, document automation utilizes Bash, Read, Write, Edit, Grep, and Glob tools to detect codebase changes and apply updates. These dependencies enable the skill to scan project files and ensure documentation consistency.

How do I resolve cross-document discrepancies in project guides?▼

Resolve cross-document discrepancies by running a post-ship update process that checks for inconsistencies across README, Architecture, and Contributing files. It automatically updates outdated sections to match the current codebase.

Can I automate version bumping in the VERSION file after a release?▼

Yes, you can optionally automate version bumping in the VERSION file after a release. The documentation update process suggests and handles version bumps when needed to keep project metadata aligned with codebase changes.

When should I update Claude.md files for code-to-document consistency?▼

Update Claude.md files for code-to-document consistency immediately after shipping codebase changes. Running a post-ship documentation update ensures Claude.md and other guides accurately reflect the newly released features and architecture.

Related Skills

Explore More Software Engineering Skills→
rshelekhovrshelekhov

document-release

Automate post-ship documentation updates across project files.

Community
Intermediate
I7T5I7T5
164

edmund-release-and-operate

Automate version bumping, CHANGELOG updates, and CI/CD execution for Edmund releases.

Community
Advanced
carbon-languagecarbon-language
33.9k

Code style

Enforce Carbon project code style across Bazel, C++, Carbon, Markdown, and Python files.

Official
Intermediate
reomgitreomgit

document-release

Update project documentation files and report documentation debt after software releases.

Community
Advanced