documentation-reviewer
CommunityElevate API docs with precision.
Authorjeickmeier
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the critical need for high-quality, comprehensive documentation for software APIs, ensuring clarity, usability, and maintainability.
Core Features & Use Cases
- Documentation Auditing: Reviews public APIs for completeness, checking for descriptions, arguments, return types, examples, and academic references.
- Quality Improvement: Identifies and suggests fixes for missing or incomplete documentation.
- Use Case: When reviewing a new Rust library, use this Skill to ensure all public functions and structs have clear doc comments, proper argument and return type descriptions, and illustrative examples, especially for financial or mathematical implementations.
Quick Start
Use the documentation reviewer skill to check the documentation quality of the finstack_core crate.
Dependency Matrix
Required Modules
None requiredComponents
referencesscripts
💻 Claude Code Installation
Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.
Please help me install this Skill: Name: documentation-reviewer Download link: https://github.com/jeickmeier/rfin/archive/main.zip#documentation-reviewer Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
Agent Skills Search Helper
Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.