doc-health-dashboard
OfficialSpot health issues in HashiCorp docs at a glance.
Content & Communication#content metrics#document quality#link health#health dashboard#structure health#HashiCorp docs
Authorhashicorp
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill provides a unified view of document health, enabling writers and reviewers to quickly identify structural, content, style, and link issues that impact clarity and reliability.
Core Features & Use Cases
- Structure health checks: validates frontmatter presence, section coverage, heading hierarchy, and list formatting.
- Content health checks: measures word count, code examples, resource links, and persona coverage.
- Style health checks: ensures voice consistency, reduces vague pronouns, and favors precise technical language.
- Link health checks: verifies internal/external link validity, descriptive text, and HashiCorp resource formatting.
- Use Case: Run the dashboard on a draft doc to surface critical issues before final review, or compare health across multiple sections.
Quick Start
Run the health dashboard on a document: /doc-health-dashboard docs/path/to/document.mdx Or compare a set of documents: /doc-health-dashboard docs/section/*.mdx
Dependency Matrix
Required Modules
None requiredComponents
Standard package💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: doc-health-dashboard Download link: https://github.com/hashicorp/web-unified-docs/archive/main.zip#doc-health-dashboard Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.