api-docs-reviewer

Audit public API documentation for consistency, accuracy, and completeness.

Updated Jan 21, 2019

Search Tags:#code review #technical writing #developer experience #rust #api documentation #documentation audit #gleam

Ready to run

npx skills add https://github.com/jtdowney/dotfiles --skill api-docs-reviewer

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-docs-reviewer
Source: https://github.com/jtdowney/dotfiles/tree/main/dot_codex/skills/api-docs-reviewer
Command: npx skills add https://github.com/jtdowney/dotfiles --skill api-docs-reviewer

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about api-docs-reviewer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I audit API documentation for missing public items?▼

You can audit API documentation by scanning all public functions, types, and modules to verify completeness. This process identifies undocumented public items and ensures critical functions have clear, working usage examples before release.

What is the best way to check doc comments against code behavior in Rust?▼

Checking doc comments against code behavior involves verifying parameter names and return types for accuracy. This ensures your Rust API documentation matches actual code behavior, preventing developer confusion.

Can I enforce uniform terminology and style across API documentation?▼

You can enforce uniform terminology and style by reviewing documentation for consistency. This checks for uniform formatting and language-specific documentation patterns, providing a structured report of findings.

Does this documentation audit work with Gleam and other programming languages?▼

This documentation audit requires adherence to language-specific documentation patterns across various programming languages. It scans public items in languages like Rust and Gleam to verify documentation completeness and accuracy.

Why does my API documentation audit report show inaccurate descriptions?▼

Your API documentation audit report shows inaccurate descriptions when documentation does not match actual code behavior. Verifying parameter names and return types against code ensures accuracy and improves developer experience.