From elixir-phoenix
Generates @moduledoc and @doc annotations for Elixir modules, contexts, and schemas. Adds README sections and ADRs for new features after implementation.
How this skill is triggered — by the user, by Claude, or both
Slash command
/elixir-phoenix:documentThe summary Claude sees in its skill listing — used to decide when to auto-load this skill
Generate documentation for newly implemented features.
Generate documentation for newly implemented features.
/phx:document .claude/plans/magic-link-auth/plan.md
/phx:document magic link authentication
/phx:document # Auto-detect from recent plan
| Output | Description |
|---|---|
@moduledoc | For new modules missing documentation |
@doc | For public functions without docs |
| README section | For user-facing features |
| ADR | For significant architectural decisions |
Run git diff --name-only HEAD~5 | grep '\.ex$' | head -20 to check for new .ex files.
If NO new .ex files were added (only modifications), skip the full
audit and report: "No new modules — documentation coverage unchanged."
This prevents 35-message analysis sessions that conclude "PASS" with
zero output (confirmed: session bb0a0454 wasted ~2K tokens on no-op).
@moduledoc, @doc).claude/plans/{slug}/reviews/{feature}-docs.md| Trigger | Create ADR |
|---|---|
| New external dependency | Yes |
| New database table | Maybe (if schema non-obvious) |
| New OTP process | Yes (explain why process needed) |
| New context | Maybe (if boundaries non-obvious) |
| New auth mechanism | Yes |
| Performance optimization | Yes |
/phx:plan → /phx:work → /phx:review
↓
/phx:document ← YOU ARE HERE (optional, suggested after review passes)
${CLAUDE_SKILL_DIR}/references/doc-templates.md — @moduledoc, @doc, README, ADR templates${CLAUDE_SKILL_DIR}/references/output-format.md — Documentation report format${CLAUDE_SKILL_DIR}/references/doc-best-practices.md — Elixir documentation best practices${CLAUDE_SKILL_DIR}/references/documentation-patterns.md — Detailed documentation patternsnpx claudepluginhub oliver-kriska/claude-elixir-phoenix --plugin elixir-phoenixWrites production-quality @moduledoc, @doc, and @typedoc annotations for Elixir modules, scaling structure to complexity with ExDoc conventions like cross-references, doctests, and return contracts. Use for thin or missing module docs.
Guides Elixir documentation with @moduledoc, @doc, @typedoc, doctests, cross-references, and metadata. Use when adding or improving docs in .ex files.
Provides templates and best practices for README files, API documentation, user guides, changelogs, inline code comments, and architecture docs.