phx:document
Generate documentation for implemented features - @moduledoc, README updates, ADRs. Run after /phx:review passes.
Resources
1Install
npx skillscat add oliver-kriska/claude-elixir-phoenix/phx-document Install via the SkillsCat registry.
SKILL.md
Document
Generate documentation for newly implemented features.
Usage
/phx:document .claude/plans/magic-link-auth/plan.md
/phx:document magic link authentication
/phx:document # Auto-detect from recent planWhat 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
- 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
/phx:plan → /phx:work → /phx:review
↓
/phx:document ← YOU ARE HERE (optional, suggested after review passes)References
references/doc-templates.md— @moduledoc, @doc, README, ADR templatesreferences/output-format.md— Documentation report formatreferences/doc-best-practices.md— Elixir documentation best practicesreferences/documentation-patterns.md— Detailed documentation patterns
Categories
Install
npx skillscat add oliver-kriska/claude-elixir-phoenix/phx-document Install via the SkillsCat registry.