document-release

Audit release documentation and map Diataxis coverage against shipped code.

15|5|Updated May 17, 2026
One-click install
npx skills add https://github.com/cropsgg/skills --skill document-release-cropsgg
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/cropsgg/skills/tree/main/skills/planning/document-release
Command: npx skills add https://github.com/cropsgg/skills --skill document-release-cropsgg

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often diverges from the shipped code after releases, causing onboarding friction and support overhead. This skill provides a structured Diataxis coverage map to show which documentation quadrants (tutorials, how-tos, reference, explanation) are present or missing and to drive a release-triggered documentation audit.

Core Features & Use Cases

  • Generate a Diataxis coverage map for the current release, highlighting coverage gaps.
  • Detect and surface drift between code and docs, enabling targeted remediation.
  • Produce a consolidated release notes section that links updated docs to code changes and evidence.

Quick Start

Run a release audit to map Diataxis coverage against shipped code and create an auditable release notes section.

Frequently Asked Questions about document-release

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

FAQPage Schema
How do I audit documentation coverage against shipped code after a release?

Run a release audit to map Diataxis coverage against shipped code, detect drift between docs and changes, and generate consolidated release notes linking updated docs to evidence.

What is a Diataxis coverage map for documentation?

A Diataxis coverage map is a structured view showing which documentation quadrants—tutorials, how-tos, reference, and explanation—are present or missing for the current release.

How do I detect drift between code changes and existing documentation?

Detect drift between code and docs by running a documentation audit after large diffs or releases, which surfaces divergence and enables targeted remediation for missing coverage.

When should I run a documentation release audit?

Run a documentation release audit after releases or large diffs to ensure Diataxis coverage aligns with shipped code, reducing onboarding friction and support overhead from outdated docs.

Can I generate release notes that link updated documentation to code changes?

Yes, produce a consolidated release notes section that links updated documentation to code changes and evidence, satisfying traceability and providing a reproducible documentation audit process.

What is the best way to fix onboarding friction caused by outdated docs?

Fix onboarding friction from outdated docs by mapping Diataxis coverage gaps after releases, detecting drift between code and documentation, and driving targeted remediation updates.