skills.rest
indigoai-us
indigoai-usOFFICIAL
Explore all skills by this author →
WebsiteGitHub

document-release

Detect API, config, and dependency changes to update documentation after release.

Updated Aug 27, 2026
Search Tags:#architecture#documentation#auto-update#release-management#claude-md#diff-analysis#index-md
One-click install
npx skills add https://github.com/indigoai-us/hq --skill document-release-indigoai-us
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: document-release
Source: https://github.com/indigoai-us/hq/tree/main/template/.claude/skills/document-release
Command: npx skills add https://github.com/indigoai-us/hq --skill document-release-indigoai-us

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Post-ship documentation audits ensure shipped products reflect actual implementation by aligning READMEs, CLAUDE.md, architecture references, and INDEX files to what was released, preventing drift.

Core Features & Use Cases

  • Auto-updates machine-consumed docs (CLAUDE.md, architecture docs, INDEX.md) to reflect shipped changes.
  • Guardrails for user-facing docs: prompts before updating READMEs and uptime on-change logging.
  • Diff-driven conformance: detects added/removed APIs, config changes, and dependencies to maintain accurate references.

Quick Start

Run the document-release skill after a release to auto-sync docs to 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 documentation updates after a code release?▼

Post-ship documentation updates can be automated by analyzing code diffs to detect new APIs, config changes, and dependencies, then applying those changes directly to machine-consumed docs like CLAUDE.md and INDEX.md.

What is post-ship documentation drift and how do I prevent it?▼

Post-ship documentation drift occurs when shipped code changes are not reflected in manuals. You prevent drift by running a diff analysis on the shipped code to identify documentation impacts and sync references.

Can I automatically update user-facing READMEs when APIs change?▼

You cannot fully automate user-facing README updates. Guardrails require the system to prompt for manual approval before updating READMEs, while machine-consumed docs like architecture docs are auto-updated.

How do I keep CLAUDE.md and INDEX.md files accurate after shipping?▼

To keep CLAUDE.md and INDEX.md accurate after shipping, run a post-release audit that detects added or removed APIs and applies auto-updates to these machine-consumed files to match the shipped implementation.

What is the best way to detect removed APIs for documentation conformance?▼

The best way to detect removed APIs for documentation conformance is using diff-driven analysis, which compares the project start state against shipped code to identify structural changes and maintain accurate references.

Related Skills

Explore More Content & Communication Skills→
SSiertsemaSSiertsema

baseline-management

Capture, compare, and release immutable baselines of artifacts with auditable history.

Community
Advanced
unfinishablemapunfinishablemap
3

expand-topic

Generate a publish-ready article draft from a topic prompt.

Community
Intermediate
neolaoneolao

docs

Generate and synchronize project documentation from source data.

Community
Advanced
hicucuhicucu
1

weekly-commits

Aggregate git commit history into structured markdown reports by timeframe and author.

Community
Intermediate