cyberneticlibrary

Audit API documentation quality

api-docs-quality-reportskillsetup L224
Infrasity-Labs/dev-gtm-claude-skills
What it does

Audit API documentation against 12 quality criteria

Best for

Assessing API doc completeness before releasing or migrating SDKs.

Inputs
  • · OpenAPI spec or Markdown docs
  • · API endpoint list
Outputs
  • · Quality score (0-100)
  • · Findings by criterion, ranked by impact
Requires
  • · OpenAPI parser
  • · Markdown parser
Preconditions
  • · Valid OpenAPI spec or documented endpoints
Failure modes
  • · Spec parse error
  • · Missing examples
  • · Inconsistent schema
Trust signals
  • · 12 quality criteria
  • · Impact ranking
  • · Score normalization