← Back to Skills Marketplace
Elixir Docs Review
by
Kevin Anderson
· GitHub ↗
· v1.2.1
· MIT-0
168
Downloads
0
Stars
1
Active Installs
2
Versions
Install in OpenClaw
/install elixir-docs-review
Description
Reviews Elixir documentation for completeness, quality, and ExDoc best practices. Use when auditing @moduledoc, @doc, @spec coverage, doctest correctness, an...
README (SKILL.md)
Elixir Documentation Review
Quick Reference
| Issue Type | Reference |
|---|---|
| @moduledoc, @doc quality, anti-patterns | references/doc-quality.md |
| @spec, @type, @typedoc coverage | references/spec-coverage.md |
Review Checklist
Module Documentation
- All public modules have @moduledoc
- First-line summary is concise (one line, used by tools as summary)
- @moduledoc includes ## Examples where appropriate
- @moduledoc false only on internal/implementation modules
Function Documentation
- All public functions have @doc
- All public functions have @spec
- @doc describes return values clearly
- Multi-clause functions documented before first clause
- Function head declared when arg names need clarification
Doctests
- Doctests present for pure, deterministic functions
- No doctests for side-effectful operations (DB, HTTP, etc.)
- Doctests actually run (module included in test file)
Cross-References
- Module references use backtick auto-linking (
MyModule) - Function refs use proper arity format (
function/2) - Type refs use t: prefix (
t:typename/0) - No plain-text references where auto-links are possible
Metadata
- @since annotations on new public API additions
- @deprecated with migration guidance where appropriate
Valid Patterns (Do NOT Flag)
- @doc false on callback implementations - Documented at behaviour level
- @doc false on protocol implementations - Protocol docs cover the intent
- Missing @spec on private functions - @spec optional for internals
- Short @moduledoc without ## Examples on simple utility modules - Not every module needs examples
- Using @impl true without separate @doc - Inherits documentation from behaviour
Context-Sensitive Rules
| Issue | Flag ONLY IF |
|---|---|
| Missing @moduledoc | Module is public AND not a protocol impl |
| Missing @spec | Function is public AND exported |
| Missing doctests | Function is pure AND deterministic |
| Generic @doc | Doc restates function name without adding value |
Gates (sequenced — do not skip)
Work in order. Do not draft or ship a finding until the prior step passes.
- Scope lock — Pass when: You listed the exact
.ex/.exsfile paths (orModulenames) under review; no vague “the project” scope. - Full-context read — Pass when: For each candidate issue, you read the full surrounding definition (all clauses for multi-clause functions; full
@moduledocblock for module-level claims), not only a diff hunk or search snippet. - Evidence bundle — Pass when: Every draft finding uses the
[FILE:LINE] ISSUE_TITLEheader (line range allowed) and includes a verbatim quote or pointer to the@doc/@spec/ doctest text in question.Module.function/aritymay appear as supporting context but does not replace the[FILE:LINE]anchor. For “doctest fails” claims, Pass when: you citemix testoutput for the relevant file or line, or the exact error string. - Protocol before report — Pass when: You loaded and followed review-verification-protocol (its Pre-Report checklist) before finalizing the issue list—not after.
When to Load References
- Reviewing @moduledoc or @doc quality, seeing anti-patterns -> doc-quality.md
- Reviewing @spec, @type, or @typedoc coverage -> spec-coverage.md
Usage Guidance
This skill appears to be what it says (an Elixir documentation reviewer) but has some implementation gaps you should resolve before trusting it: 1) Confirm the agent environment has Elixir and mix available if you expect it to run doctests (the skill references mix test but does not declare it). 2) The SKILL.md requires loading a '../review-verification-protocol/SKILL.md' file that is not included — ask the publisher for that file or supply it yourself. 3) If you will allow the agent to run tests or read your repository files, ensure it only has access to the project directory and not other sensitive locations. If these points are clarified (and you’re comfortable with the agent running mix/test commands on your codebase), the skill is reasonable; until then treat it with caution.
Capability Tags
Capability Assessment
Purpose & Capability
The skill claims to audit Elixir docs and doctests, which legitimately can require running tests and reading .ex/.exs sources. However, the skill declares no required binaries or environment needs while the runtime instructions explicitly expect 'mix test' output and full project file reads. The absence of a declared dependency on Elixir/mix (or a note that the agent must be run in an environment with mix available) is an inconsistency.
Instruction Scope
SKILL.md stays within doc-audit scope (checks @moduledoc, @doc, @spec, doctests, evidence bundling). It does not ask for unrelated credentials or system-wide secrets. Two issues: (1) it requires producing 'mix test' output for doctest failures (implying the agent will execute tests or require test artifacts), and (2) it mandates loading and following a review-verification-protocol at '../review-verification-protocol/SKILL.md' which is not included in the skill bundle — this missing referenced file is a gap that could block correct operation or cause the agent to fetch external content.
Install Mechanism
Instruction-only skill with no install spec and no code files written to disk. This is low-risk from an install/execution distribution perspective.
Credentials
The skill requests no environment variables, credentials, or config paths, which is proportionate for a doc-reviewer. There is no request for unrelated secrets or elevated access.
Persistence & Privilege
always:false and no installation steps that persist or modify other skills or system settings. The skill does not request permanent presence or elevated privileges.
How to Use
- Make sure OpenClaw is installed (local or Docker)
- Run the install command in chat:
/install elixir-docs-review - After installation, invoke the skill by name or use
/elixir-docs-review - Provide required inputs per the skill's parameter spec and get structured output
Version History
v1.2.1
- Added a new "Gates" section specifying a sequenced checklist to follow before drafting or submitting findings, emphasizing evidence and process.
- Clarified the requirement for precise scope, full-context reading, and detailed evidence in review reports.
- Stated that the pre-report verification protocol must be followed before finalizing issues, not after.
- No changes to functional review checklists or valid pattern clarifications.
v1.2.0
elixir-docs-review 1.2.0 changelog:
- Expanded documentation review guidelines with detailed checklists for modules, functions, doctests, cross-references, and metadata.
- Added quick reference mapping common issues to supporting documentation.
- Clarified valid patterns that should not be flagged during review.
- Introduced context-sensitive rules for more accurate audits.
- Specified protocol for reviewing and submitting findings via a verification protocol.
Metadata
Frequently Asked Questions
What is Elixir Docs Review?
Reviews Elixir documentation for completeness, quality, and ExDoc best practices. Use when auditing @moduledoc, @doc, @spec coverage, doctest correctness, an... It is an AI Agent Skill for Claude Code / OpenClaw, with 168 downloads so far.
How do I install Elixir Docs Review?
Run "/install elixir-docs-review" in the OpenClaw or Claude Code chat to install it in one step — no extra setup required.
Is Elixir Docs Review free?
Yes, Elixir Docs Review is completely free, licensed under MIT-0. You can download, install and use it at no cost.
Which platforms does Elixir Docs Review support?
Elixir Docs Review is cross-platform and runs anywhere OpenClaw / Claude Code is available (cross-platform).
Who created Elixir Docs Review?
It is built and maintained by Kevin Anderson (@anderskev); the current version is v1.2.1.
More Skills