elixir-docs-review
CommunityElevate Elixir code quality with doc audits.
Authorjavierhbr
Version1.0.0
Installs0
System Documentation
What problem does it solve?
This Skill addresses the challenge of maintaining high-quality, comprehensive documentation in Elixir projects, ensuring code clarity and maintainability.
Core Features & Use Cases
- Documentation Auditing: Reviews
@moduledoc,@doc, and@speccoverage for completeness and adherence to best practices. - Doctest Verification: Checks the correctness and applicability of embedded doctests.
- Cross-Reference Validation: Ensures proper usage of auto-linking for modules, functions, and types.
- Use Case: Before merging a new feature, use this Skill to audit the documentation of all public modules and functions, verifying that
@moduledocand@specare present and that doctests are accurate.
Quick Start
Use the elixir-docs-review skill to audit the documentation of the provided Elixir code.
Dependency Matrix
Required Modules
None requiredComponents
references
💻 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: elixir-docs-review Download link: https://github.com/javierhbr/random-poc/archive/main.zip#elixir-docs-review 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 471,000+ vetted skills library on demand.