Phx Document

What it does

When your agent uses it

• Tasks that involve Architecture decision records
• Tasks that involve Technical documentation

Example prompts

• “/phx-document”

Workflow steps

5 steps, taken from the first numbered list in SKILL.md.

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

What it can do on your machine

Read from SKILL.md and the folder at commit 9767a82. It shows what the files ask for, not the result of running them.

• Tool permissions

  Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

  From allowed-tools in the SKILL.md frontmatter.

• Runs code

  Shell commands in SKILL.md call:

  • git

  From the folder's file list and the shell code blocks in SKILL.md.

• Network

  No URLs in SKILL.md. Its commands use git, which can reach the network depending on how they are called.

  From URLs in SKILL.md, links to its own repository left out.

• Credentials

  Names no API keys, tokens, secrets or passwords.

  From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Phx Document loads about 745 tokens when it runs, and up to ~3.1k if it reads all its reference files. Until then it costs about 32 tokens; SKILL.md has 299 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it

~32

When it runs · the whole SKILL.md, loaded when a task matches

~745

With references · SKILL.md plus every file in references/, read only if the agent opens them

~3.1k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from oliver-kriska/claude-elixir-phoenix at commit 9767a82, republished under its MIT licence (© oliver-kriska). 299 words, ~745 tokens.

name

phx-document

description

Document tested Elixir APIs; may update README/ADRs. Not for docs lookup, audits/reviews, or standalone decisions.

$elixir-phoenix:phx-document .claude/plans/magic-link-auth/plan.md
$elixir-phoenix:phx-document magic link authentication
$elixir-phoenix:phx-document  # Auto-detect from recent plan

$elixir-phoenix:phx-plan → $elixir-phoenix:phx-work → $elixir-phoenix:phx-review
       ↓
$elixir-phoenix:phx-document  ← YOU ARE HERE (optional, suggested after review passes)

© oliver-kriska, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

SKILL.md and 4 other files (references) in targets/codex/skills/phx-document of oliver-kriska/claude-elixir-phoenix.

• SKILL.md
• references/doc-best-practices.md
• references/doc-templates.md
• references/documentation-patterns.md
• references/output-format.md

Open the folder on GitHubat commit 9767a82