skills.rest
AlejandroFigini
AlejandroFiginiCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

document-release

Audit project docs and align them with shipped changes.

Updated Mar 27, 2026
Search Tags:#automation#documentation#audit#diff#CLAUDE.md#CHANGELOG
One-click install
npx skills add https://github.com/AlejandroFigini/artist-portfolio --skill document-release-alejandrofigini
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/AlejandroFigini/artist-portfolio/tree/main/.agent/skills/document-release
Command: npx skills add https://github.com/AlejandroFigini/artist-portfolio --skill document-release-alejandrofigini

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation often drifts from code changes, causing confusion and misalignment across READMEs, architecture notes, and CLAUDE.md. This skill ensures the documentation stays in sync with shipped changes.

Core Features & Use Cases

  • Cross-file audit: scans README.md, ARCHITECTURE.md, CLAUDE.md, and CHANGELOG to identify drift and outdated references.
  • Auto-update & polish: applies factual updates, standardizes tone, and improves link integrity across docs.
  • Diataxis mapping: builds a Diataxis coverage map (reference/how-to/tutorial/explanation) to surface documentation debt.

Quick Start

Run the document-release skill after a ship release to audit docs and align key project documents.

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 updates across README and CLAUDE.md?▼

Automate post-ship documentation updates by running a cross-file audit that scans README.md, ARCHITECTURE.md, CLAUDE.md, and CHANGELOG to identify drift and apply factual updates after a release ship.

What is documentation drift and how do I check for outdated references after a release?▼

Documentation drift happens when project docs fall out of sync with code changes. Check for outdated references by running a cross-file audit that surfaces documentation debt and misalignment across README and architecture notes.

How do I build a Diataxis coverage map to surface documentation debt?▼

Build a Diataxis coverage map by categorizing existing docs into reference, how-to, tutorial, and explanation quadrants to identify gaps and surface documentation debt across the project.

Can I standardize changelog tone and improve link integrity automatically?▼

Standardize changelog tone and improve link integrity automatically by applying auto-update and polish workflows that apply factual updates, standardize tone, and fix links across project documents.

What is the best way to keep ARCHITECTURE.md aligned with shipped changes?▼

Keep ARCHITECTURE.md aligned with shipped changes by automating consistency checks that scan for drift and apply factual updates to architecture notes after every release.

When should I run a documentation audit for post-ship consistency?▼

Run a documentation audit for post-ship consistency immediately after a release to ensure README, ARCHITECTURE, CLAUDE.md, and CHANGELOG stay aligned with shipped code changes.

Related Skills

Explore More Content & Communication Skills→
mikeacjonesmikeacjones

doc-sync

Synchronize CLAUDE.md navigation indexes and README architecture docs across a repository.

Community
Basic
timurgaleevtimurgaleev
5

document-release

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

Community
Advanced
SjdjdiejdrirhdkjejSjdjdiejdrirhdkjej

production-deployment-phase

Promote validated staging builds to production with semantic versioning and health checks.

Community
Advanced
jonkikyjonkiky

document-release

Update project documentation to reflect shipped changes after a merge.

Community
Intermediate