skills.rest
DecoyLex
DecoyLexCOMMUNITY
Explore all skills by this author →
GitHub

write-docs

Draft and review Elixir documentation against project style guides and ExDoc conventions.

2|Updated Mar 6, 2026
Search Tags:#documentation#elixir#style-guide#documentation-review#doctest#exdoc#moduledoc
One-click install
npx skills add https://github.com/DecoyLex/ltix --skill write-docs-decoylex
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: write-docs
Source: https://github.com/DecoyLex/ltix/tree/main/.claude/skills/write-docs
Command: npx skills add https://github.com/DecoyLex/ltix --skill write-docs-decoylex

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Write or review Elixir documentation following the project's style guide. Use when writing @moduledoc, @doc, guides, or reviewing existing docs for quality. Invoke with "/write-docs" or when the user asks to write, improve, or review documentation.

Core Features & Use Cases

  • Clear guidelines for moduledoc, doc, and guide content.
  • Templates and patterns to ensure consistency and readability across Elixir docs.
  • Review and improvement workflows that help maintain documentation quality over time.

Quick Start

Run /write-docs to generate clear, style-aligned Elixir documentation for modules and functions.

Frequently Asked Questions about write-docs

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

FAQPage Schema
How do I write Elixir documentation that follows a consistent style guide?▼

To align Elixir documentation with a style guide, draft and review @moduledoc and @doc content using enforced structure, tone, and examples. This ensures consistency across modules, packages, and guides.

What is the best way to review existing Elixir module documentation for quality?▼

Reviewing Elixir documentation quality involves checking existing @moduledoc and @doc against style guidelines for structure and tone. Improvement workflows help maintain documentation consistency over time.

Does Elixir documentation generation work with ExDoc conventions and Doctests?▼

Elixir documentation generation aligns with ExDoc conventions and provides Doctest guidance. Checking consistency with ExDoc ensures generated docs render correctly and execute examples properly.

How do I generate documentation templates for Elixir functions and modules?▼

Generating Elixir documentation templates provides patterns for @moduledoc and @doc content. These templates ensure structural consistency and readability across Elixir modules and functions.

Can I use a style guide to review both Elixir library guides and module docs?▼

Style-guided Elixir documentation review targets both module docs and guides. Enforcing consistent tone and structure across all documentation types maintains quality across libraries and packages.

Related Skills

Explore More Content & Communication Skills→
layeddielayeddie
1

elixir-guidelines

Standardize Elixir codebases with official naming, structure, and documentation standards.

Community
Intermediate
javierhbrjavierhbr

exdoc-config

Configures ExDoc for Elixir projects via mix.exs project and docs functions.

Community
Intermediate
AbeJitsuAbeJitsu

format-standardize

Apply user-defined formatting standards across code, documentation, and content outputs using ESLint and Prettier.

Community
Basic
jey3dayojey3dayo
6

markdown-docs

Review Markdown documentation for clarity, structure, and technical accuracy.

Community
Intermediate