skills.rest
HatmanStack
HatmanStackCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

doc-health

Audit documentation against codebase reality to identify drift and gaps.

Updated Feb 20, 2026
Search Tags:#documentation#codebase#audit#remediation#pipeline#drift
One-click install
npx skills add https://github.com/HatmanStack/news-investor --skill doc-health-hatmanstack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-health
Source: https://github.com/HatmanStack/news-investor/tree/main/.claude/skills/doc-health
Command: npx skills add https://github.com/HatmanStack/news-investor --skill doc-health-hatmanstack

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill addresses the common issue of documentation becoming outdated or inaccurate as code evolves, leading to confusion and errors.

Core Features & Use Cases

  • Documentation Drift Audit: Compares existing documentation against the current state of the codebase to identify discrepancies.
  • Automated Planning: Generates a structured plan for remediation based on the audit findings.
  • Use Case: Before a major release, run this Skill to ensure all API documentation accurately reflects the latest code changes, preventing developer onboarding issues.

Quick Start

Run the doc-health skill to audit all documentation in the current repository.

Frequently Asked Questions about doc-health

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

FAQPage Schema
How do I audit my documentation for drift against a codebase?▼

Documentation drift occurs when docs become outdated as code evolves. Auditing identifies these gaps and stale content by comparing existing documentation against the current state of the codebase to prevent confusion and errors.

What's the best way to check for stale API documentation before a major release?▼

Running an audit before a major release ensures all API documentation accurately reflects the latest code changes, preventing developer onboarding issues by identifying outdated or inaccurate content.

How do I generate a remediation plan for outdated documentation?▼

You generate a remediation plan by running an audit that analyzes documentation against codebase reality. The audit outputs a comprehensive document detailing drift, gaps, and stale content for pipeline remediation.

Can I scope a documentation audit to specific parts of a repository?▼

Yes, you can scope a documentation audit to specific parts of a repository. The audit supports scoping questions for targeted audits and integrates with agent-based execution for detailed, focused analysis.

Does a documentation drift audit suggest preventative tooling for pipelines?▼

Yes, a documentation drift audit suggests preventative tooling for pipelines. It analyzes codebase reality across multiple phases to identify drift and outputs recommendations for preventative pipeline tooling.

How does an automated documentation audit integrate with agent-based execution?▼

An automated documentation audit integrates with agent-based execution to perform detailed analysis. This integration allows the audit to thoroughly compare documentation against codebase reality across multiple phases.

Related Skills

Explore More Software Engineering Skills→
pingmepipingmepi

pm-context-scan-codebase

Scan a codebase to generate a structured markdown summary of architecture, features, and technical debt.

Community
Intermediate
AgentSecOpsAgentSecOps
183

container-grype

Scan container images and SBOMs for vulnerabilities with Grype.

Official
Advanced
jonmummjonmumm
2

babysit-pr

Monitor PR CI checks and surface failures for diagnosis and fixes.

Community
Advanced
dt418dt418

Docs Pack

Build documentation platforms with versioned docs, search, navigation, code highlighting, and API reference generation.

Community
Intermediate