check-quality-metrics

Assess document quality against defined metrics and generate a structured report.

78|252|Updated Feb 7, 2024
One-click install
npx skills add https://github.com/hashicorp/web-unified-docs --skill check-quality-metrics
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: check-quality-metrics
Source: https://github.com/hashicorp/web-unified-docs/tree/main/content/well-architected-framework/docs/.claude/skills/check-quality-metrics
Command: npx skills add https://github.com/hashicorp/web-unified-docs --skill check-quality-metrics

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill identifies documents that fail to meet defined content quality standards and summarizes gaps.

Core Features & Use Cases

  • Quality score checks: Word count, structure, and presence of key sections to ensure depth and clarity.
  • Resource and persona validation: Verifies presence of critical references and coverage for decision-makers and implementers.
  • Guided remediation: Highlights gaps and provides actionable guidance to bring documents up to standard.

Quick Start

Run the skill against a document to generate a quality report. For example, /check-quality-metrics docs/path/to/document.mdx

Frequently Asked Questions about check-quality-metrics

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

FAQPage Schema
How do I automate document quality checks for product docs and tutorials?

To automate document quality checks, run this skill against MDX files to measure word count, validate frontmatter, and verify structure. It produces a structured quality report highlighting gaps and providing actionable remediation guidance.

What metrics are used to review documentation quality and structure?

Documentation quality metrics include word count, presence of code examples, link verification, and persona coverage for decision-makers and implementers. The review enforces requirements by validating frontmatter and recommended sections.

Can I validate frontmatter and persona coverage in governance pages?

Yes, you can validate frontmatter and persona coverage in governance pages. The skill verifies the presence of critical references and ensures coverage for both decision-makers and implementers to meet defined content standards.

Does this quality review tool work with MDX documents?

Yes, this quality review tool works with MDX documents. You can run it against a specific document path, such as docs/path/to/document.mdx, to assess depth, clarity, and resource validation.

What is the best way to identify documents failing content quality standards?

The best way to identify documents failing content quality standards is to run this skill to automatically summarize gaps. It assesses your product docs against defined metrics and highlights missing key sections.