oliver-kriska/claude-elixir-phoenix / targets/dsh/skills/phx-document
phx-document
VerifiedUse 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.
| File | Kind | Size |
|---|---|---|
| SKILL.md | skill md | 2.9 KB |
| references/doc-best-practices.md | markdown | 600 B |
| references/doc-templates.md | markdown | 1.1 KB |
| references/documentation-patterns.md | markdown | 6.9 KB |
| references/output-format.md | markdown | 803 B |
references/doc-best-practices.md
View on GitHub# Elixir Documentation Best Practices
## @moduledoc
- First line: One sentence summary
- Include `## Usage` with iex examples
- Include `## Options` if configurable
- Link to related modules with `See also`
## @doc
- First line: What it does (imperative)
- `## Parameters` with types
- `## Returns` with tagged tuples
- `## Examples` with iex
## Typespecs
Always pair @doc with @spec:
```elixir
@doc "Creates a magic token for the given user."
@spec create_magic_token(User.t()) :: {:ok, MagicToken.t()} | {:error, Ecto.Changeset.t()}
def create_magic_token(%User{} = user) do
# ...
end
```
Related skills
| Skill | Stars | Updated | Works with | Status | Install |
|---|---|---|---|---|---|
| rea-analysis-optimizationmorluto/reaOptimize REA providers and shared analysis workflows for agent context, latency, CPU, and memory while preserving correctness and Evidence. Use for analysis bottlenecks and cache or query design; CI/test-suite optimization belongs to rea-ci-tests-audit. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-ci-tests-auditmorluto/reaAudit REA CI and test suites for correctness, fixture drift, false passes, and measured performance; use for suite or workflow investigations and efficiency changes, rather than ordinary feature testing or a single test failure. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| rea-tool-designmorluto/reaAudit, investigate, design, or change REA investigation tools, CLI/MCP contracts, provider capabilities, and Evidence semantics. | Stars: 472k | Updated | Claude CodeCodex | Verified | Install |
| ponytail-auditDietrichGebert/ponytailQuality audit of the whole repo: bugs, security, real load, missing tests, speed, and what to delete. Most important first. | Stars: 194k | Updated | Claude CodeCodex | Verified | Install |