doc-health

Audit BizzyForge documentation for staleness and propose ARCHIVE or UPDATE actions.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/deachne/BizzyForge --skill doc-health
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-health
Source: https://github.com/deachne/BizzyForge/tree/main/.claude/skills/doc-health
Command: npx skills add https://github.com/deachne/BizzyForge --skill doc-health

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit BizzyForge documentation for freshness, relevance, and alignment with current practices, using a systematic 5-agent workflow to surface stale, orphaned, out-of-sync, and outdated docs.

Core Features & Use Cases

  • 5-Agent Health Pipeline runs weekly or on-demand to inventory docs, assess relevance, and verify codebase synchronization.
  • Actions & Outputs generate a DOC-HEALTH-REPORT.md, ARCHIVE suggestions, and tasks in BLOCKERS-AND-GAPS.md.
  • Applicable to docs in docs/, .claude/skills/, .playgrounds/, and root Markdown docs for ongoing maintenance.

Quick Start

Run the 5-agent doc health audit to inventory docs, assess relevance, and generate an actionable report.

Frequently Asked Questions about doc-health

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

FAQPage Schema
How do I audit stale documentation and keep it synced with my codebase?

You can audit stale documentation by running a 5-agent pipeline weekly or on-demand across docs/, .claude/skills/, and root markdowns to flag out-of-sync files and propose ARCHIVE or UPDATE actions.

What is a documentation health-check and what outputs does it generate?

A documentation health-check is a systematic audit that surfaces stale, orphaned, and out-of-sync docs, generating a DOC-HEALTH-REPORT.md, ARCHIVE suggestions, and tasks added to BLOCKERS-AND-GAPS.md.

How do I identify orphaned or outdated markdown files in my repository?

You identify orphaned or outdated markdown files by running the health pipeline to inventory docs and assess relevance against current practices, flagging issues for structured ARCHIVE or UPDATE actions.

Can I run a docs maintenance audit on specific directories like .playgrounds/ and root markdowns?

Yes, you can run the docs maintenance audit on specific directories including docs/, .claude/skills/, .playgrounds/, and root markdowns to ensure comprehensive repository coverage and alignment.

What's the best way to track documentation maintenance tasks after an audit?

The best way to track documentation maintenance tasks after an audit is to automatically append actionable items and findings to a BLOCKERS-AND-GAPS.md file for ongoing task tracking.

When should I archive documentation instead of updating it?

You should archive documentation instead of updating it when the 5-agent pipeline flags files as orphaned or irrelevant to current practices, proposing structured ARCHIVE actions rather than UPDATE actions.