agentleFS
refpathrefpath/chatgpt-team/.agents/skills/elixir-docs/SKILL.md

elixir-docs

Skill0 starsChanged 2 months agoMITView on GitHub

Author and validate Elixir public API documentation, moduledocs, typedocs, doctests, and ExDoc guides. Use when Elixir documentation or its generated output changes; exclude unrelated frontend-only writing.

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 1 is distinctive, and 2 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use full module names, function arities, t: type references, c: callback references, and sections starting at ##.

    line 12
  2. Distinctive:

    Use truthful examples that exercise the public entry point.

    line 14
  3. Very specific:

    No universal section template, minimum length, or coverage percentage establishes quality.

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Elixir documentation

Inspect mix.exs, locked Elixir/ExDoc versions, public API boundaries, documentation configuration, tests, and project instructions. Use supported options from those versions; do not add a coverage tool or upgrade a dependency just to follow this skill.

  1. Inspect the implementation, types, callbacks, and tests behind each changed claim. Reconcile contradictions with the implementation owner; a prose task must not silently alter the contract.
  2. Give public modules a useful opening summary and explain when a consumer should use them. Document relevant inputs, outputs, options, errors, effects, and process/resource ownership in proportion to complexity.
  3. Use full module names, function arities, t: type references, c: callback references, and sections starting at ##. Put a function's documentation before its first clause. Record since or deprecation information only from real history. See Elixir's documentation guidance.
  4. Preserve intentionally internal APIs. Respect @moduledoc false, @doc false, and the default hidden documentation for callback implementations marked @impl true. Private functions use source comments when explanation is useful. See Module attributes.
  5. Use truthful examples that exercise the public entry point. Read validation for doctests, ExDoc output, and release-specific checks.

No universal section template, minimum length, or coverage percentage establishes quality. Keep accurate short docs short. Use the available technical-writing and unslop skills for substantial organization and editing; keep technical verification in this skill.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.