skills.rest
javierhbr
javierhbrCOMMUNITY
Explore all skills by this author →
GitHub

elixir-docs-review

Review Elixir documentation for ExDoc best practices and doctest correctness.

Updated Feb 17, 2026
Search Tags:#quality assurance#code review#documentation#elixir#doctest#exdoc
One-click install
npx skills add https://github.com/javierhbr/random-poc --skill elixir-docs-review
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: elixir-docs-review
Source: https://github.com/javierhbr/random-poc/tree/main/custom-skills/beagle-main/plugins/beagle-elixir/skills/elixir-docs-review
Command: npx skills add https://github.com/javierhbr/random-poc --skill elixir-docs-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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 @spec coverage 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 @moduledoc and @spec are present and that doctests are accurate.

Quick Start

Use the elixir-docs-review skill to audit the documentation of the provided Elixir code.

Frequently Asked Questions about elixir-docs-review

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

FAQPage Schema
How do I audit Elixir documentation for ExDoc best practices?▼

Checking Elixir @spec coverage ensures your public functions have clear type contracts, improving code clarity and allowing tools like ExDoc to generate accurate API references for other developers.

How do I verify doctest correctness in Elixir .ex files?▼

Verifying doctest correctness in Elixir .ex files involves checking that embedded documentation examples are accurate and applicable. This validates that your documented code examples function exactly as written when executed.

What is the best way to validate cross-references in Elixir module documentation?▼

Validating cross-references in Elixir module documentation requires ensuring proper usage of auto-linking for modules, functions, and types. This guarantees that ExDoc generates navigable and accurate internal links across your project.

Does Elixir code review for documentation require any specific dependencies?▼

Elixir documentation review does not require specific external dependencies to analyze .ex files. The review process directly evaluates @moduledoc, @doc, and @spec attributes against ExDoc best practices without needing additional libraries.

When should I review Elixir documentation before merging new code?▼

You should review Elixir documentation before merging new code to confirm all public modules and functions have complete @moduledoc and @spec coverage. This ensures new features maintain established clarity and maintainability standards.

Related Skills

Explore More Software Engineering Skills→
oliver-kriskaoliver-kriska
517

phx:document

Generate @moduledoc, @doc, README sections, and ADRs for Elixir/Phoenix projects.

Community
Intermediate
javierhbrjavierhbr

exdoc-config

Configures ExDoc for Elixir projects via mix.exs project and docs functions.

Community
Intermediate
jfrometajfrometa

lint-and-validate

Run lint, type checks, and security audits on Node.js and Python projects.

Community
Advanced
kreuzberg-devkreuzberg-dev
836

elixir-bindings-patterns

Implement Elixir bindings for Rust logic using the Rustler NIF bridge.

Official
Advanced