skills.rest
TumeloRamaphosa
TumeloRamaphosaCOMMUNITY
Explore all skills by this author →
GitHub

document-release

Audit project docs against code diffs and build a Diataxis coverage map.

Updated May 7, 2026
Search Tags:#changelog#documentation#release automation#Diataxis#architecture drift#post-ship sync#PR readiness
One-click install
npx skills add https://github.com/TumeloRamaphosa/StudEx-Valley-OS --skill document-release-tumeloramaphosa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/TumeloRamaphosa/StudEx-Valley-OS/tree/main/.claude/skills/gstack/document-release
Command: npx skills add https://github.com/TumeloRamaphosa/StudEx-Valley-OS --skill document-release-tumeloramaphosa

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill prevents documentation from drifting behind what shipped by automatically auditing the repo’s docs, mapping coverage by Diataxis type, and updating key files so users and contributors see the same truth as the codebase.

Core Features & Use Cases

  • Diataxis coverage map: Classifies documentation into reference/how-to/tutorial/explanation and highlights coverage gaps.
  • Release doc synchronization: Reads all project docs, cross-references the diff, updates README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md to match what actually shipped.
  • Drift detection and polish: Detects architecture diagram drift, polishes CHANGELOG voice using a sell-test rubric, cleans up TODOs, and can bump version if needed.
  • PR-ready visibility: Surfaces documentation debt in the PR body so review is focused on what still needs attention.

Quick Start

Use the document-release Skill to update the project docs after a release by asking the AI to run document-release for the latest shipped changes.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I synchronize documentation with code changes after a release?▼

To synchronize documentation with code changes, audit all project docs, cross-reference the diff, and update README, ARCHITECTURE, CONTRIBUTING, and CLAUDE.md files to match what actually shipped.

What is a Diataxis coverage map for documentation?▼

A Diataxis coverage map classifies documentation into reference, how-to, tutorial, and explanation categories, highlighting coverage gaps to ensure comprehensive post-ship documentation synchronization.

How do I detect and fix architecture drift in my documentation?▼

Detect architecture drift by cross-referencing the codebase diff against existing architecture notes, updating outdated diagrams, and polishing the changelog voice using a sell-test rubric.

What's the best way to surface documentation debt in a pull request?▼

Surface documentation debt in a PR by auditing repo docs, mapping Diataxis coverage, and injecting remaining TODOs and uncovered gaps directly into the PR body for focused review.

Can I automate changelog polishing and version bumping during post-merge workflows?▼

Automate changelog polishing and version bumping during post-merge workflows by applying a sell-test rubric to the changelog voice, cleaning up TODOs, and optionally bumping the project version.

Does this approach work for post-ship sync without external dependencies?▼

Post-ship sync works without external dependencies by relying on automated drift detection, Diataxis categorization, and targeted file updates applied directly to the existing repository structure.

Related Skills

Explore More Content & Communication Skills→
doodledooddoodledood
4

review-coverage

Analyze code diffs to identify and quantify test coverage gaps.

Community
Advanced
JaimeJunrJaimeJunr
2

release

Automate release management with changelog validation, version bumps, and git tagging.

Community
Advanced
bordenetbordenet
8

link-verification

Validate and verify Markdown links in documentation before publishing.

Community
Advanced
SSiertsemaSSiertsema

documentation-tooling-selection

Evaluate documentation tooling against audience, content, and technical criteria.

Community
Advanced