oliver-kriska/claude-elixir-phoenix / targets/codex/skills/phx-document
phx-document
VerifiedDocument tested Elixir APIs; may update README/ADRs. Not for docs lookup, audits/reviews, or standalone decisions.
| 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-templates.md
View on GitHub# Documentation Templates
## @moduledoc Template
```elixir
@moduledoc """
{Brief description of module purpose}.
## Usage
iex> MyApp.Module.function(arg)
:result
## Options
* `:option` - Description of option
## Examples
# Example usage
MyApp.Module.do_thing()
"""
```
## @doc Template
```elixir
@doc """
{Brief description}.
## Parameters
* `param` - Description
## Returns
* `{:ok, result}` - On success
* `{:error, reason}` - On failure
## Examples
iex> function(:arg)
{:ok, :result}
"""
```
## README Section Template
For features users interact with:
````markdown
## {Feature Name}
{Brief description}
### Configuration
```elixir
# config/config.exs
config :my_app, :feature,
option: value
```
### Usage
{How to use the feature}
````
## ADR Template
Create `docs/adr/{number}-{title}.md`:
```markdown
# ADR-{n}: {Title}
**Date**: {date}
**Status**: Accepted
**Context**: {Why this decision was needed}
## Decision
{What was decided}
## Consequences
### Positive
- {benefit}
### Negative
- {tradeoff}
## Alternatives Considered
### {Alternative 1}
- Rejected because: {reason}
```
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 |