api-reference-documentation

Creates professional API documentation using OpenAPI specifications with endpoints, authentication, and interactive examples. Use when documenting REST APIs, creating SDK references, or building developer portals.

1.01x

Quality

68%

Does it follow best practices?

Impact

93%

1.01x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Optimize this skill with Tessl

npx tessl skill review --optimize ./plugins/api-reference-documentation/skills/api-reference-documentation/SKILL.md

Evaluation results

95%

API Specification for a User Management Service

OpenAPI spec structure

Criteria

Without context

With context

OpenAPI 3.0+ version

100%

Info contact email

100%

Multiple servers

100%

Bearer JWT security scheme

100%

50%

Global security applied

100%

Endpoint tags

100%

Schema $ref usage

100%

Required fields declared

100%

Property type constraints

100%

Error responses documented

100%

Parameter types defined

100%

85%

Developer Integration Guide for a Payment Processing API

API documentation completeness

Criteria

Without context

With context

Pagination documented

100%

Rate limits documented

100%

Multi-language SDK examples

100%

Request body examples

100%

Response body examples

100%

Auth code example

100%

Interactive tool referenced

Error responses covered

100%

API v2 Launch Documentation for a Logistics Platform

API versioning and migration

Criteria

Without context

With context

Breaking changes listed

100%

Before/after examples

100%

Migration steps provided

100%

v1 docs maintained

100%

v2 docs present

100%

Version in spec info

100%

Deprecation notice

100%

New auth requirements documented

100%

Repository: secondsky/claude-skills
Commit: 90d6bd7

Evaluated: 29 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

API Specification for a User Management Service Developer Integration Guide for a Payment Processing API API v2 Launch Documentation for a Logistics Platform

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.