docs-health

Audits custom element manifests for documentation completeness and quality using cem health JSON output.

46|4|Updated May 27, 2025
One-click install
npx skills add https://github.com/bennypowers/cem --skill docs-health-bennypowers
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-health
Source: https://github.com/bennypowers/cem/tree/main/extensions/claude-code/skills/docs-health
Command: npx skills add https://github.com/bennypowers/cem --skill docs-health-bennypowers

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit custom element manifests for documentation completeness and quality, helping teams identify gaps in descriptions, attributes, slots, and demos so documentation remains accurate and actionable.

Core Features & Use Cases

  • Phase 1: Run Health Analysis to generate a structured score report using cem health with a JSON output.
  • Phase 2: Interpret Results by examining per-module and per-declaration scores and findings to prioritize improvements.
  • Phase 3: Generate a clear, actionable report with recommendations and targeted remediation steps for documentation health across components and MCP resources.
  • Optional: Perform deeper investigations via cem://element/{tagName} resources for in-depth gaps.

Quick Start

Run cem health to generate a JSON health report for your element manifests.

Frequently Asked Questions about docs-health

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

FAQPage Schema
How do I audit custom element manifests for documentation completeness?

You audit custom element manifests by running cem health to generate a structured JSON score report. This surfaces per-declaration details and identifies documentation gaps across components, attributes, slots, and demos.

What is a custom element manifest documentation health audit?

A documentation health audit analyzes custom element manifests to score documentation completeness and quality. It identifies missing descriptions, attributes, slots, or demos so documentation remains accurate and actionable.

How do I interpret custom element manifest health scores and findings?

Interpret custom element manifest health scores by examining per-module and per-declaration findings in the generated JSON output. This helps prioritize improvements and generate actionable remediation steps for documentation gaps.

Can I perform deeper investigations into specific web component documentation gaps?

Yes, you can perform deeper investigations into specific web component documentation gaps via cem://element/{tagName} resources. This allows in-depth analysis of individual elements beyond the standard health report.

Does the manifest documentation audit require any specific dependencies?

The manifest documentation audit requires no external dependencies, but it does require cem health usage to run the analysis. It then surfaces structured scores and recommendations in the output.