Audit public API documentation for consistency, accuracy, and completeness.
npx skills add https://github.com/jtdowney/dotfiles --skill api-docs-reviewer
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
This Skill ensures that your public API documentation is consistent, accurate, and complete, preventing confusion and improving developer experience.
Use the api-docs-reviewer skill to audit the documentation for the 'user-management' module.
High-intent search queries and answers about installing and using this skill.
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.
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.
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.
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.
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.
xiaolaiIdentify public Rust API items and verify doc-comment conventions.
dapperdiversGenerate structured markdown penetration test reports from JSON security scan findings.
ianyimiEnforce global coding style guidelines across multi-language codebases.
nikhillinitDetect and prioritize technical debt with configurable thresholds and SQALE metrics.
