Agent skill

Phx Document

by oliver-kriska in oliver-kriska/claude-elixir-phoenix

A skill your agent uses when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions.

MITAuto-check passedDevelopment

Install Phx Document

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .claude/skills && cp -r skills-src/targets/pi/skills/phx-document .claude/skills/phx-document && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Paste into Claude Code

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .claude/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

Claude Code copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

$skill-installer

$skill-installer install https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document

Type this inside Codex. $skill-installer <name> installs a curated skill from openai/skills. The installer writes to $CODEX_HOME/skills (default ~/.codex/skills). Restart Codex if the skill does not show up.

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a codex

Project install goes to .agents/skills/; add -g for ~/.codex/skills/.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document --agent codex

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .agents/skills && cp -r skills-src/targets/pi/skills/phx-document .agents/skills/phx-document && rm -rf skills-src

Use ~/.agents/skills/ instead of .agents/skills for a personal install.

Codex skills documentation · loads skills from .agents/skills/

Paste into Codex

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .agents/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

Codex copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a cursor

Project install goes to .agents/skills/; add -g for ~/.cursor/skills/.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document --agent cursor

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .cursor/skills && cp -r skills-src/targets/pi/skills/phx-document .cursor/skills/phx-document && rm -rf skills-src

Use ~/.cursor/skills/ instead of .cursor/skills for a personal install.

Cursor skills documentation · loads skills from .cursor/skills/, .agents/skills/, .claude/skills/, .codex/skills/

Paste into Cursor

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .cursor/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

Cursor copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

gemini skills install

$ gemini skills install https://github.com/oliver-kriska/claude-elixir-phoenix.git --path targets/pi/skills/phx-document

--scope user (default) or --scope workspace; --path is the subfolder of the repo that holds the skill; --consent skips the security confirmation prompt.

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a gemini-cli

Project install goes to .agents/skills/; add -g for ~/.gemini/skills/.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document --agent gemini-cli

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .gemini/skills && cp -r skills-src/targets/pi/skills/phx-document .gemini/skills/phx-document && rm -rf skills-src

Use ~/.gemini/skills/ instead of .gemini/skills for a personal install, then run /skills reload.

Gemini CLI skills documentation · loads skills from .gemini/skills/, .agents/skills/

Paste into Gemini CLI

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .gemini/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

Gemini CLI copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document

Installs for Copilot at project scope by default; add --scope user for a personal install. Preview a skill first with gh skill preview. Needs GitHub CLI 2.90.0 or later (public preview).

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a github-copilot

Project install goes to .agents/skills/; add -g for ~/.copilot/skills/.

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .github/skills && cp -r skills-src/targets/pi/skills/phx-document .github/skills/phx-document && rm -rf skills-src

Use ~/.copilot/skills/ instead of .github/skills for a personal install. Commit .github/skills so cloud agent and code review can use it.

GitHub Copilot skills documentation · loads skills from .github/skills/, .claude/skills/, .agents/skills/

Paste into GitHub Copilot

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .github/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

GitHub Copilot copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

skills CLI

$ npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a opencode

OpenCode documents no install command of its own. Project install goes to .agents/skills/; add -g for ~/.config/opencode/skills/.

GitHub CLI

$ gh skill install oliver-kriska/claude-elixir-phoenix phx-document --agent opencode

Project scope by default (.agents/skills/); add --scope user for a personal install.

Manual copy

$ git clone --depth 1 https://github.com/oliver-kriska/claude-elixir-phoenix.git skills-src && mkdir -p .opencode/skills && cp -r skills-src/targets/pi/skills/phx-document .opencode/skills/phx-document && rm -rf skills-src

Use ~/.config/opencode/skills/ instead of .opencode/skills for a personal install.

OpenCode skills documentation · loads skills from .opencode/skills/, .claude/skills/, .agents/skills/

Paste into OpenCode

Install the "phx-document" agent skill from https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/targets/pi/skills/phx-document into .opencode/skills/phx-document/ in this project. Copy the whole folder (SKILL.md and every file beside it), keep the folder name "phx-document", then confirm the skill loads.

OpenCode copies the folder itself, the same result as the manual copy. Check what it changed before you commit it.

Facts

Skill name: phx-document
GitHub stars: 565
Token cost: ~750 tokens
SKILL.md length: 299 words
Files: 5 (incl. references)
Skills in repo: 111
Repo updated: Oct 5, 2026
First seen: Oct 7, 2026
Licence: MIT

At a glance

A skill your agent uses when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions.

Works in 5 steps: Never remove existing documentation —… → @moduledoc on every public module —… → ADRs capture the "why", not the "what" —… → …
Asked to document Elixir code: add
SKILL.md covers Usage, Iron Laws, What Gets Documented and Workflow, plus 3 more sections
Calls git

What it does

Phx Document is an agent skill from oliver-kriska/claude-elixir-phoenix. 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.

Its SKILL.md is about 750 tokens, which your agent loads only when the skill is triggered. The skill folder holds 5 other files, including reference files (for example `references/doc-best-practices.md`, `references/doc-templates.md` and `references/documentation-patterns.md`).

It sits in Development, covering Architecture decision records and Technical documentation. It works with Elixir. The repository describes itself as: Claude Code plugin for Elixir/Phoenix/LiveView — 26 specialist agents, Iron Laws enforcement, and Tidewave MCP integration. Plan features with parallel research agents, execute… The licence is MIT.

When your agent uses it

Asked to document Elixir code: add
Fill in @moduledoc and @doc for modules and functions

Example prompts

“/phx-document”

Workflow steps

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

Never remove existing documentation — Existing docs may reflect design intent that isn't obvious from code alone; update rather than replace
@moduledoc on every public module — Undocumented modules accumulate quickly and create onboarding friction for new team members
ADRs capture the "why", not the "what" — Code shows what was built; ADRs explain why this approach was chosen over alternatives
Match @doc to function's public API — Document parameters, return values, and edge cases; callers shouldn't need to read the implementation
DO 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 750 tokens when it runs, and up to ~3.1k if it reads all its reference files. Until then it costs about 52 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: ~52
When it runs · the whole SKILL.md, loaded when a task matches: ~750
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

Auto-check passed

The automated check found no risky patterns in SKILL.md.

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, ~750 tokens.

Download SKILL.mdSave it as .claude/skills/phx-document/SKILL.md (or your agent's skills folder). This skill also uses 4 other files; get the full folder from GitHub.

name: phx-document
description: 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.

Document

Generate documentation for newly implemented features.

Usage

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

Iron Laws

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

What Gets Documented

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

Workflow

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

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." A full audit of unchanged coverage produces nothing to add.

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

When to Generate ADRs

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

Integration with Workflow

text

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

References

references/doc-templates.md — @moduledoc, @doc, README, ADR templates
references/output-format.md — Documentation report format
references/doc-best-practices.md — Elixir documentation best practices
references/documentation-patterns.md — Detailed documentation patterns

Files

SKILL.md and 4 other files (references) in targets/pi/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

Compare with similar skills

Phx Document next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Phx Document compared with similar skills
Skill	Stars	Used in	Tokens	Auto-check	Licence	Repo updated
Phx Document this skilloliver-kriska/claude-elixir-phoenix	565	—	~750	Automated safety check: Pass	MIT	3 days ago
Docsbrickbots/PiFinder	250	—	~6.2k	Automated safety check: Pass	GPL-3.0	yesterday
Evidence-Backed Documentation Writerbgauryy/octocode	949	—	~2k	Automated safety check: Pass	MIT	today
Write Vibe ADRmistralai/mistral-vibe	5.1k	—	~942	Automated safety check: Pass	Apache-2.0	yesterday
Technical Documentation Templatesbybren-llc/safe-agentic-workflow	423	—	~1.2k	Automated safety check: Pass	MIT	2 mo ago
Prosestatic-web-server/static-web-server	2.4k	—	~971	Automated safety check: Pass	Apache-2.0	yesterday

Similar skills

Docs
brickbots/PiFinder
Author and edit PiFinder's user-facing documentation in the project's house style.
250 GitHub stars~6.2k tokensUpdated yesterday
DevelopmentAuto-check passed
Evidence-Backed Documentation Writer
bgauryy/octocode
Writes, repairs and copyedits project docs against the Google developer documentation style guide, verifying claims in the repository before stating them.
949 GitHub stars~2k tokensUpdated today
DevelopmentAuto-check passed
Write Vibe ADR
mistralai/mistral-vibe
Official
Creates or updates concise Architecture Decision Records for the Mistral Vibe CLI and registers each one in the AGENTS.md decisions table.
5.1k GitHub stars~942 tokensUpdated yesterday
DevelopmentAuto-check passed
Technical Documentation Templates
bybren-llc/safe-agentic-workflow
Documentation templates for ADRs, runbooks, architecture docs, and knowledge transfer documents. Use when creating Architecture Decision Records, writing…
423 GitHub stars~1.2k tokensUpdated 2 mo ago
DevelopmentAuto-check passed
Prose
static-web-server/static-web-server
Author or edit any prose for the Static Web Server (SWS) project — documentation, design docs, READMEs, PR descriptions, issue bodies, commit message bodies, or other human-readable text — following…
2.4k GitHub stars~971 tokensUpdated yesterday
DevelopmentAuto-check passed
Agent Style
pchalasani/claude-code-tools
Literature-backed English technical-prose writing rules (agent-style, 21 rules).
2k GitHub stars~1.4k tokensUpdated yesterday
DevelopmentAuto-check passed

Questions about Phx Document

What does Phx Document do?

A skill your agent uses when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions. Phx Document is an agent skill from oliver-kriska/claude-elixir-phoenix. Use when asked to document Elixir code: add or fill in @moduledoc and @doc for modules and functions.

When should I use Phx Document?

Phx Document fits situations like: asked to document Elixir code: add; fill in @moduledoc and @doc for modules and functions.

How do I install Phx Document in Claude Code?

Run `npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a claude-code`. Or copy the skill folder (targets/pi/skills/phx-document in oliver-kriska/claude-elixir-phoenix) into .claude/skills/phx-document in your project. Claude Code loads it when a task matches its description.

How do I install Phx Document in Codex?

Run `npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a codex`. Or copy the skill folder (targets/pi/skills/phx-document in oliver-kriska/claude-elixir-phoenix) into .agents/skills/phx-document in your project. Codex loads it when a task matches its description.

Can I use Phx Document in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add oliver-kriska/claude-elixir-phoenix --skill phx-document -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/phx-document, .gemini/skills/phx-document, .github/skills/phx-document and .opencode/skills/phx-document in your project.

What does Phx Document need to run?

Going by SKILL.md and its folder, Phx Document needs the command-line tools its instructions call (git).

Does Phx Document access the network?

SKILL.md contains no URLs. Its commands use git, which can reach the network depending on how they are called. This is read from the text; nothing was executed.

Is Phx Document safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Phx Document use?

Phx Document is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Phx Document use?

About 750 tokens (SKILL.md is roughly 3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full. Its references folder adds about 2.4k tokens, read only when the agent opens those files.

What are the alternatives to Phx Document?

Skills that share tags, products or a category with Phx Document: Docs (brickbots/PiFinder, 250 stars), Evidence-Backed Documentation Writer (bgauryy/octocode, 949 stars), Write Vibe ADR (mistralai/mistral-vibe, 5.1k stars) and Technical Documentation Templates (bybren-llc/safe-agentic-workflow, 423 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Phx Document?

oliver-kriska (a GitHub user) maintains it in oliver-kriska/claude-elixir-phoenix, which has 565 GitHub stars. The repository holds 111 skills in this directory. The repository was last updated on October 5, 2026.

Source: oliver-kriska/claude-elixir-phoenix on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.

Install Phx Document

Facts

At a glance

What it does

When your agent uses it

Example prompts

Workflow steps

What it can do on your machine

Tool permissions

Runs code

Network

Credentials

Context cost

Safety

SKILL.md

Document

Usage

Iron Laws

What Gets Documented

Workflow

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

When to Generate ADRs

Integration with Workflow

References

Files

Compare with similar skills

Similar skills

More from oliver-kriska/claude-elixir-phoenix

Related

Questions about Phx Document