api-docs-reviewer

What problem does it solve?

This Skill ensures that your public API documentation is consistent, accurate, and complete, preventing confusion and improving developer experience.

Core Features & Use Cases

• Completeness Check: Verifies that all public API elements (functions, types, modules) are documented.
• Accuracy Verification: Compares documentation against actual code behavior, parameter names, and return types.
• Consistency Review: Enforces uniform terminology, formatting, and style across all documentation.
• Example Coverage: Ensures that critical functions have clear, working usage examples.
• Use Case: When releasing a new library version, use this Skill to automatically audit its documentation for any missing or inaccurate descriptions before publishing.

Quick Start

Use the api-docs-reviewer skill to audit the documentation for the 'user-management' module.