skills.rest
timurgaleev
timurgaleevCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Audit code diffs and generate a Diataxis coverage map for repository documentation.

5|Updated Apr 24, 2026
Search Tags:#documentation#diataxis#pr-management#diff-audit#docs-debt
One-click install
npx skills add https://github.com/timurgaleev/vibestack --skill document-release-timurgaleev
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/timurgaleev/vibestack/tree/main/skills/document-release
Command: npx skills add https://github.com/timurgaleev/vibestack --skill document-release-timurgaleev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts as code evolves. This Skill automates aligning repo docs with shipped changes, surfaces documentation debt, and prepares PR bodies to reflect the update.

Core Features & Use Cases

  • Audit diffs to identify affected documentation areas across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md.
  • Build a Diataxis coverage map (reference/how-to/tutorial/explanation) to surface gaps and drift.
  • Propose documentation updates, flag architecture diagram drift, and polish CHANGELOG voice without overwriting existing entries.

Quick Start

Trigger the /document-release workflow after a ship to align docs with the 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 automate post-ship documentation alignment with code changes?▼

Automate post-ship documentation alignment by auditing code diffs to identify affected areas across README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md, then generating proposed updates to close the gap.

What is a Diataxis coverage map for documentation debt?▼

A Diataxis coverage map categorizes documentation into reference, how-to, tutorial, and explanation types to surface gaps and drift, highlighting where shipped code changes lack corresponding documentation updates.

How do I update a CHANGELOG without overwriting existing entries?▼

Update a CHANGELOG without overwriting existing entries by polishing the voice of newly generated entries to match the current format, appending version bump prompts and shipped changes while preserving the historical log.

Can I detect architecture diagram drift after shipping a release?▼

Yes, you can detect architecture diagram drift by mapping surface changes from code diffs to ARCHITECTURE.md, flagging areas where the documented structure no longer reflects the shipped repository state.

Does documentation drift auditing work for multi-file repository docs?▼

Documentation drift auditing works across multiple repository files, reading diffs and mapping surface changes to README.md, ARCHITECTURE.md, CONTRIBUTING.md, and CHANGELOG.md to ensure comprehensive coverage.

Related Skills

Explore More Content & Communication Skills→
ShaheerKhawajaShaheerKhawaja
8

document-release

Audit release diffs and update core documentation files to match shipped changes.

Community
Advanced
tethertotetherto
395

sdk-backmerge

Create pull requests to backmerge release version bumps and changelogs into main.

Official
Advanced
LazyIsEfficientLazyIsEfficient
15

documentation-writer

Apply diff-based documentation updates to docs/ and root README during PR workflows.

Official
Intermediate
TumeloRamaphosaTumeloRamaphosa

document-release

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

Community
Advanced