elixir-writing-docs

Community

Master Elixir documentation standards.

Authorjavierhbr
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This Skill helps developers write clear, comprehensive, and maintainable documentation for their Elixir code, improving code quality and developer onboarding.

Core Features & Use Cases

  • Standardized Documentation: Guides on using @moduledoc, @doc, @typedoc, and doctests according to Elixir best practices.
  • Code Clarity: Ensures documentation is accurate, easy to understand, and effectively communicates the purpose and usage of code.
  • Use Case: When writing a new Elixir module, use this Skill to ensure your @moduledoc includes a concise summary, relevant examples, and configuration details, making it immediately understandable to other developers.

Quick Start

Use the elixir-writing-docs skill to document the MyApp.Inventory module, including examples and configuration.

Dependency Matrix

Required Modules

None required

Components

references

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: elixir-writing-docs
Download link: https://github.com/javierhbr/random-poc/archive/main.zip#elixir-writing-docs

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.