code-documenter

Generates, formats, and validates technical documentation — including docstrings, OpenAPI/Swagger specs, JSDoc annotations, doc portals, and user guides. Use when adding docstrings to functions or classes, creating API documentation, building documentation sites, or writing tutorials and user guides. Invoke for OpenAPI/Swagger specs, JSDoc, doc portals, getting started guides.

1.10x

Quality

100%

Does it follow best practices?

Impact

93%

1.10x

Average score across 6 eval scenarios

Securityby

Passed

No known issues

Evaluation results

100%

13%

Document a FastAPI Payment Processing Service

Python FastAPI docstrings and coverage report

Criteria

Without context

With context

Google-style Args block

100%

Google-style Returns block

100%

Raises block present

100%

FastAPI summary param

100%

FastAPI tags param

100%

FastAPI response_model

100%

Pydantic Field with example

75%

100%

Class Attributes section

100%

Coverage report generated

100%

Before/After coverage stats

40%

100%

Files modified table

37%

100%

99%

Document a NestJS Order Management API

NestJS TypeScript JSDoc and Swagger decorators

Criteria

Without context

With context

JSDoc @param tags

100%

JSDoc @returns tags

100%

JSDoc @throws tags

100%

JSDoc @example blocks

100%

@ApiTags on controllers

100%

@ApiOperation on endpoints

100%

@ApiResponse for success

100%

@ApiResponse for errors

100%

@ApiProperty on DTOs

100%

90%

@ApiPropertyOptional for optional

100%

@ApiBearerAuth decorator

100%

Coverage report generated

100%

76%

Build a Documentation Site for a Python Data Validation SDK

MkDocs site with user guides and troubleshooting

Criteria

Without context

With context

MkDocs chosen

100%

Material theme configured

100%

Material theme features

100%

mkdocstrings plugin

Nav structure configured

100%

Quick start prerequisites

37%

Quick start verify step

100%

Tutorial with checkpoints

50%

100%

Troubleshooting format

100%

Mermaid diagram included

100%

Progressive disclosure in auth/config

FAQ section present

100%

92%

Document a Django REST Framework Inventory API

Django REST Framework API documentation with drf-spectacular

Criteria

Without context

With context

drf-spectacular chosen

100%

@extend_schema on views

100%

@extend_schema summary field

100%

OpenApiParameter usage

100%

OpenApiExample usage

100%

Serializer help_text

100%

ViewSet docstring format

37%

100%

Error responses documented

100%

Coverage report generated

100%

Coverage Before/After stats

25%

100%

Files Modified table

100%

Documentation style noted

100%

91%

Document a Python Statistics Utility Library

Python NumPy-style docstrings with doctest validation

Criteria

Without context

With context

NumPy Parameters section

100%

NumPy Returns section

100%

NumPy Raises section

100%

NumPy Examples section

100%

Parameter type annotation in docstring

100%

doctest validation run

100%

doctest examples pass

100%

interrogate or pydocstyle used

10%

Coverage report generated

100%

Coverage Before/After stats

33%

100%

No Google-style Args blocks

100%

24%

Create API Documentation for a Task Management Service

OpenAPI 3.1 spec with reusable components and Redocly validation

Criteria

Without context

With context

OpenAPI 3.1 version

100%

Reusable schemas

100%

Reusable parameters

100%

Reusable responses

100%

Security scheme defined

100%

Security applied to paths

100%

Redocly lint run

100%

Spec passes lint

60%

100%

Error response codes documented

100%

Request body with schema

100%

Field examples included

100%

Coverage report generated

100%

Repository: jeffallan/claude-skills
Commit: 5b76101

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

Table of Contents

Document a FastAPI Payment Processing Service Document a NestJS Order Management API Build a Documentation Site for a Python Data Validation SDK Document a Django REST Framework Inventory API Document a Python Statistics Utility Library Create API Documentation for a Task Management Service

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.