Does this skill replace my existing documentation?

No, the skill follows 'Iron Laws' that prioritize updating and appending to existing documentation rather than replacing it, preserving the original design intent.

Can I use this for specific modules or features?

Yes, you can provide a specific plan file or feature name as an argument, or allow the skill to auto-detect recent changes in your repository.

When does the skill suggest creating an ADR?

ADRs are suggested for significant changes such as adding external dependencies, new database tables, OTP processes, or security mechanisms.

What documentation standards does it follow?

It uses standard Elixir documentation patterns, ensuring @moduledoc is present on every public module and @doc matches the public API parameters and return values.

Elixir & Phoenix Documentation

Name: Elixir & Phoenix Documentation
Author: oliver-kriska

byoliver-kriska

•

学习与文档

Generates comprehensive Elixir documentation, README updates, and Architectural Decision Records (ADRs) for Phoenix and LiveView projects.

The phx:document skill automates the creation of high-quality documentation for Elixir and Phoenix applications, ensuring your codebase remains maintainable and transparent. It intelligently detects new modules and features to generate @moduledoc and @doc strings, updates README files, and drafts ADRs to capture the 'why' behind architectural choices. By strictly adhering to Elixir best practices and 'Iron Laws,' it prevents documentation rot and ensures that public APIs are always clear, documented, and ready for team collaboration.

主要功能

0162 GitHub stars

02Enforcement of documentation standards to ensure parameters and return values are always defined.

03Intelligent detection of undocumented code based on recent commits or specific plan files.

04Dynamic README updates to keep user-facing feature documentation in sync with the code.

05Architectural Decision Record (ADR) creation to document the rationale behind design choices.

06Automated @moduledoc and @doc generation for all public Elixir modules and functions.

使用场景

01Finalizing a feature branch by generating comprehensive documentation before submitting a pull request.

02Documenting complex architectural decisions like new OTP processes or external dependencies via ADRs.

03Maintaining 100% documentation coverage across large-scale Phoenix/LiveView projects to reduce onboarding friction.

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add oliver-kriska/claude-elixir-phoenix document

For use in Claude.ai and ChatGPT

Download Skill