phx:document

Generate @moduledoc, @doc, README sections, and ADRs for Elixir/Phoenix projects.

517|35|Updated Feb 12, 2026
One-click install
npx skills add https://github.com/oliver-kriska/claude-elixir-phoenix --skill phx-document
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: phx:document
Source: https://github.com/oliver-kriska/claude-elixir-phoenix/tree/main/plugins/elixir-phoenix/skills/document
Command: npx skills add https://github.com/oliver-kriska/claude-elixir-phoenix --skill phx-document

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill automates the generation of essential documentation for your Elixir/Phoenix projects, ensuring code clarity, maintainability, and adherence to best practices.

Core Features & Use Cases

  • Automated Doc Generation: Creates @moduledoc and @doc for new modules and functions.
  • README Updates: Adds user-facing feature descriptions to your project's README.
  • ADR Creation: Generates Architecture Decision Records for significant technical choices.
  • Use Case: After implementing a new authentication feature, run this Skill to automatically generate module documentation, update the README with usage instructions, and create an ADR explaining the chosen authentication strategy.

Quick Start

Use the phx:document skill to generate documentation for the magic link authentication feature.

Frequently Asked Questions about phx:document

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate moduledoc and doc annotations for Elixir Phoenix modules?

You can automatically generate moduledoc and doc annotations for Elixir Phoenix modules by running this documentation generation skill after code implementation to create inline documentation for new modules and public functions.

What is the best way to document architectural decisions in an Elixir Phoenix project?

The best way to document architectural decisions in an Elixir Phoenix project is to generate Architecture Decision Records (ADRs) that explain significant technical choices, which this skill creates automatically to improve code maintainability and knowledge sharing.

Can I automatically update a README with new feature descriptions after implementing a Phoenix authentication module?

Yes, you can automatically update a README with new feature descriptions after implementing a Phoenix authentication module by running this skill to add user-facing usage instructions alongside generating the required module documentation.

When do I need to run documentation generation for Phoenix code?

You need to run documentation generation for Phoenix code after completing code review and implementing new features, ensuring inline module documentation, README sections, and ADRs remain up-to-date and integrated into your development workflow.

Do I need to install external dependencies to generate ADRs and README sections for Elixir code?

No, you do not need to install external dependencies to generate ADRs and README sections for Elixir code, as this documentation skill operates without any required dependencies to automate the creation of project documentation.