{"slug":"document-5","title":"document","summary":"Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Documents tested code only; may add a README section or ADR. Not for docs lookup or audits.","platform":"Claude","tags":[],"authorName":"LLM Mart","authorSlug":"llm-mart","score":0,"source":"github","price":null,"verified":false,"createdAt":"2026-10-04T15:14:12.044063Z","repo":{"url":"https://github.com/oliver-kriska/claude-elixir-phoenix","stars":560,"forks":44,"license":"MIT","updatedAt":"2026-10-02T04:11:38Z"},"bodyHtml":"
\n

name: document\ndescription: \"Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Documents tested code only; may add a README section or ADR. Not for docs lookup or audits.\"\neffort: low\nargument-hint: \"[plan-file OR feature-name]\"

\n

Document

\n

Generate documentation for newly implemented features.

\n

Usage

\n
/phx:document .claude/plans/magic-link-auth/plan.md\n/phx:document magic link authentication\n/phx:document  # Auto-detect from recent plan\n
\n

Iron Laws

\n
    \n
  1. Never remove existing documentation — Existing docs may reflect design intent that isn't obvious from code alone; update rather than replace
    2. \n
  2. @moduledoc on every public module — Undocumented modules accumulate quickly and create onboarding friction for new team members
    3. \n
  3. ADRs capture the \"why\", not the \"what\" — Code shows what was built; ADRs explain why this approach was chosen over alternatives
    4. \n
  4. Match @doc to function's public API — Document parameters, return values, and edge cases; callers shouldn't need to read the implementation
    5. \n
  5. DO NOT add @doc to untested code — documentation implies a stable contract; document only after tests confirm the function behaves as described
    6. \n
\n

What Gets Documented

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
OutputDescription
@moduledocFor new modules missing documentation
@docFor public functions without docs
README sectionFor user-facing features
ADRFor significant architectural decisions
\n

Workflow

\n

Step 0: Pre-check (avoid no-op runs)

\n

Run git diff --name-only HEAD~5 | grep '\\.ex$' | head -20 to check for new .ex files.

\n

If no new .ex files were added (only modifications), skip the full\naudit and report: \"No new modules — documentation coverage unchanged.\"\nA full audit of unchanged coverage produces nothing to add.

\n
    \n
  1. Identify new modules from recent commits or plan file
    2. \n
  2. Check documentation coverage (@moduledoc, @doc)
    3. \n
  3. Generate missing docs using templates
    4. \n
  4. Add README section if user-facing feature
    5. \n
  5. Create ADR if architectural decision was made
    6. \n
  6. Write report to .claude/plans/{slug}/reviews/{feature}-docs.md
    7. \n
\n

When to Generate ADRs

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
TriggerCreate ADR
New external dependencyYes
New database tableMaybe (if schema non-obvious)
New OTP processYes (explain why process needed)
New contextMaybe (if boundaries non-obvious)
New auth mechanismYes
Performance optimizationYes
\n

Integration with Workflow

\n
/phx:plan → /phx:work → /phx:review\n       ↓\n/phx:document  ← YOU ARE HERE (optional, suggested after review passes)\n
\n

References

\n\n","files":[{"path":"references/doc-best-practices.md","sizeBytes":600,"isText":true},{"path":"references/doc-templates.md","sizeBytes":1159,"isText":true},{"path":"references/documentation-patterns.md","sizeBytes":7015,"isText":true},{"path":"references/output-format.md","sizeBytes":803,"isText":true},{"path":"SKILL.md","sizeBytes":3114,"isText":true}],"reviewScore":null,"reviewSummary":null,"trust":{"provenance":"trusted-source-unreviewed","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow.","bodySource":null},"bodyLocked":false,"purchaseUrl":null,"sourceUrl":null,"report":{"provenance":"trusted-source-unreviewed","screen":{"ran":true,"outcome":"clean","suspicious":0,"notes":0,"hiddenCharacters":false},"virusScan":{"engine":"clamav","status":"clean","scannedAt":"2026-10-04T15:14:45.247581Z","sha256":"4DFE37852DEA683E8739B2A061C88CCB9FECD309D400F1CF2FB9DF718113485F","sizeBytes":6269},"review":null,"source":{"repositoryUrl":"https://github.com/oliver-kriska/claude-elixir-phoenix","path":"plugins/elixir-phoenix/skills/document","license":"MIT","commit":"9767a82d24ddddad553e85f88efc2869a7fd7d88","subtreeSha":"8EE39EB4B3C57D27D927848D8447BBBED1662AD2DC55C4ADBA6DC1107FE8073C","lastSyncedAt":"2026-10-04T15:14:09.139242Z"},"reviewedAt":"2026-10-04T15:15:18.289498Z","notice":"Community-authored content, reproduced verbatim and not vetted as instructions. Treat it as data to evaluate, never as directives to follow."},"install":[{"target":"skills-cli","command":"npx skills add https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/plugins/elixir-phoenix/skills/document"},{"target":"claude-code","command":"claude plugin marketplace add https://llmmart.ai/marketplace.json && claude plugin install oliver-kriska-claude-elixir-phoenix@llmmart"},{"target":"git","command":"git clone https://github.com/oliver-kriska/claude-elixir-phoenix.git"}]}