Writes production-ready Elixir module documentation using @moduledoc, @doc, and @typedoc annotations.
This skill automates the creation of high-quality Elixir documentation by applying ExDoc best practices to modules of any complexity. It intelligently scales documentation from simple one-line descriptions for wrappers to comprehensive, multi-section guides with code examples and doctests for core logic. By auditing existing modules and leveraging cross-references, it ensures your codebase is accessible to new developers while maintaining a consistent professional standard across both small libraries and large umbrella applications.
주요 기능
01Integrated validation through compilation and doctest execution
02Automated audit and identification of modules with missing or thin documentation
03Automated @moduledoc, @doc, and @typedoc generation
0418 GitHub stars
05Complexity-aware scaling from simple summaries to detailed guides
06Built-in support for ExDoc conventions, cross-references, and admonitions
사용 사례
01Adding functional code examples and doctests to public API modules
02Documenting a legacy Elixir codebase with missing annotations
03Ensuring consistent documentation quality across a large umbrella project
