api-docs-quality-report
Audits any API documentation site by crawling every endpoint page and scoring each one across 5 checks: description quality, OpenAPI spec presence, body param descriptions, response codes, and response schema completeness. Produces a polished interactive HTML report with a summary scorecard, site-wide pattern analysis, ranked top issues, and per-endpoint findings with specific fix guidance. Trigger this skill whenever a user provides a documentation URL and asks to audit, review, analyse, or check their API docs. Also trigger for: "do the same audit for X", "audit docs.company.com", "check the
npx skills add Infrasity-Labs/dev-gtm-claude-skills --skill api-docs-quality-report --agent claude-code
Same command for any agent — swap --agent for codex, cursor, copilot.
Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.
# API Docs Audit Skill Crawls every API reference endpoint page on a documentation site, scores each against 5 quality checks, detects site-wide patterns, and outputs an interactive HTML report matching the style of previously-generated audits in this session. --- ## STEP 0 — COLLECT INPUT You need exactly one input: the docs URL. If the user hasn't provided it, ask: > Which API docs URL should I audit? If the URL is provided, strip trailing slashes and confirm it before proceeding. **Special case — "do the same for X":** If the user says "do the same" or "same audit for X", they want the identical workflow and HTML report format applied to the new URL. Proceed directly to Step 1. --- ## STEP 1 — DISCOVER ALL ENDPOINT PAGES ### 1a. Try llms.txt first Fetch `<docs_url>/llms.txt`. If found: - Extract every line matching the pattern `- [Page Title](URL): description` - Filter to API reference pages only — look for paths containing any of: `api-reference`, `api-reference/`, `/api/`, `/endpoints/`, `/rest/`, `/docs/`, `/reference/` or versioned paths (e.g., `/v1/`) - Exclude: overview/index pages (no HTTP method implied), SDK docs, CLI docs, Terraform docs, guides, quickstart pages - St
- STEP 0 — COLLECT INPUT
- STEP 1 — DISCOVER ALL ENDPOINT PAGES
- 1a. Try llms.txt first
- 1b. Identify categories
- STEP 2 — CHECK OPENAPI SPEC AVAILABILITY
- STEP 3 — FETCH AND PARSE ALL ENDPOINT PAGES
- 3a. Page-level prose description
- 3b. OpenAPI block
- STEP 4 — SCORE EACH ENDPOINT (5 CHECKS)
- STEP 5 — DETECT SITE-WIDE PATTERNS
- STEP 6 — COMPILE TOP ISSUES
- STEP 7 — BUILD SCORECARD
- STEP 8 — GENERATE HTML REPORT
- ERROR HANDLING
What does the api-docs-quality-report skill do?
Audits any API documentation site by crawling every endpoint page and scoring each one across 5 checks: description quality, OpenAPI spec presence, body param descriptions, response codes, and response schema completeness. Produces a polished interactive HTML report with a summary scorecard, site-wide pattern analysis, ranked top issues, and per-endpoint findings with specific fix guidance. Trigger this skill whenever a user provides a documentation URL and asks to audit, review, analyse, or check their API docs. Also trigger for: "do the same audit for X", "audit docs.company.com", "check the
How do I install it?
Run `npx skills add Infrasity-Labs/dev-gtm-claude-skills --skill api-docs-quality-report --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.
Where does this skill come from?
From Infrasity-Labs/dev-gtm-claude-skills, a repository with 97 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.
Is a popular skill a good skill?
Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.