document-release

Synchronize project documentation with code diffs after releases.

Updated May 27, 2026
One-click install
npx skills add https://github.com/Shmurdoc/EasyRide-v1 --skill document-release-shmurdoc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/Shmurdoc/EasyRide-v1/tree/main/.opencode/skills/gstack-document-release
Command: npx skills add https://github.com/Shmurdoc/EasyRide-v1 --skill document-release-shmurdoc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

After code ships, documentation often drifts out of sync, leaving stale READMEs, missing architecture updates, and accumulated TODO debt. This Skill automates the tedious post-ship documentation sweep so teams maintain accurate, trustworthy docs without manual effort.

Core Features & Use Cases

  • Diataxis Coverage Mapping: Automatically builds a reference/how-to/tutorial/explanation coverage map from project docs and cross-references it against recent code changes.
  • Drift Detection & Correction: Identifies architecture diagram drift, outdated README/ARCHITECTURE/CONTRIBUTING sections, and stale CLAUDE.md references, then updates them to match what actually shipped.
  • CHANGELOG Polish & Debt Surfacing: Applies a sell-test rubric to polish CHANGELOG voice and surfaces documentation debt directly in the PR body for immediate visibility.

Quick Start

Use the document-release skill to sync all project documentation with the latest shipped code and surface any documentation debt in the PR body.

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 a code release?

Automate documentation updates after a code release by cross-referencing code diffs with project docs to update stale README, ARCHITECTURE, and CHANGELOG files automatically. This Skill performs the post-ship documentation sweep to maintain accuracy without manual effort.

What is documentation drift and how do I detect architecture diagram drift?

Documentation drift occurs when shipped code changes leave project docs out of sync. Detect architecture diagram drift by cross-referencing recent code diffs against existing markdown files to identify and update outdated structural references.

How do I keep my CHANGELOG and README in sync with merged PRs?

Keep your CHANGELOG and README in sync with merged PRs by reading project markdown files, detecting outdated sections, and updating them to match what actually shipped. It also polishes the CHANGELOG voice and surfaces documentation debt in the PR body.

Can I map documentation coverage using the Diataxis framework automatically?

Map documentation coverage using the Diataxis framework automatically by building a reference, how-to, tutorial, and explanation coverage map from project docs, then cross-referencing it against recent code changes to spot gaps.

Does this documentation synchronization tool work without external dependencies?

Yes, this documentation synchronization tool works without external dependencies. It reads your existing project markdown files, analyzes code diffs, and generates documentation debt reports directly within your software engineering workflow.

What is the best way to surface documentation debt during PR review?

The best way to surface documentation debt during PR review is to generate an automated debt report directly in the PR body. This provides immediate visibility into stale content and missing architecture updates for reviewers.