elixir-docs-review — for Claude Code elixir-docs-review, PyAgent, community, for Claude Code, ide skills, MyModule, Elixir, Review, Reference, moduledoc

v1.0.0
GitHub

关于此技能

适用场景： Ideal for AI agents that need elixir documentation review. 本地化技能摘要： elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

功能特性

Elixir Documentation Review
Issue Type Reference
------------ -----------
@moduledoc, @doc quality, anti-patterns references/doc-quality.md
@spec, @type, @typedoc coverage references/spec-coverage.md

# 核心主题

for Claude Code MyModule Elixir Review Reference moduledoc
DebVisor DebVisor
[4]
[0]
更新于: 4/7/2026

技能概览

先看适用场景、限制条件和安装路径，再决定是否继续深入。

适用场景： Ideal for AI agents that need elixir documentation review. 本地化技能摘要： elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

核心价值

推荐说明： elixir-docs-review helps agents elixir documentation review. elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

适用 Agent 类型

适用场景： Ideal for AI agents that need elixir documentation review.

↓ 赋予的主要能力 · elixir-docs-review

适用任务： Applying Elixir Documentation Review
适用任务： Applying Issue Type Reference
适用任务： Applying ------------ -----------

! 使用限制与门槛

  • 限制说明： @moduledoc false only on internal/implementation modules
  • 限制说明： Function head declared when arg names need clarification
  • 限制说明： Valid Patterns (Do NOT Flag)

关于来源内容

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

实验室 Demo

Browser Sandbox Environment

⚡️ Ready to unleash?

Experience this Agent in a zero-setup browser environment powered by WebContainers. No installation required.

Boot Container Sandbox

常见问题与安装步骤

以下问题与步骤与页面结构化数据保持一致，便于搜索引擎理解页面内容。

? FAQ

elixir-docs-review 是什么？

适用场景： Ideal for AI agents that need elixir documentation review. 本地化技能摘要： elixir-docs-review helps AI agents handle repository-specific developer workflows with documented implementation details.

如何安装 elixir-docs-review？

运行命令：npx killer-skills add DebVisor/PyAgent/elixir-docs-review。支持 Cursor、Windsurf、VS Code、Claude Code 等 19+ IDE/Agent。

elixir-docs-review 适用于哪些场景？

典型场景包括：适用任务： Applying Elixir Documentation Review、适用任务： Applying Issue Type Reference、适用任务： Applying ------------ -----------。

elixir-docs-review 支持哪些 IDE 或 Agent？

该技能兼容 Cursor, Windsurf, VS Code, Trae, Claude Code, OpenClaw, Aider, Codex, OpenCode, Goose, Cline, Roo Code, Kiro, Augment Code, Continue, GitHub Copilot, Sourcegraph Cody, and Amazon Q Developer。可使用 Killer-Skills CLI 一条命令通用安装。

elixir-docs-review 有哪些限制？

限制说明： @moduledoc false only on internal/implementation modules；限制说明： Function head declared when arg names need clarification；限制说明： Valid Patterns (Do NOT Flag)。

↓ 安装步骤

  1. 1. 打开终端

    在你的项目目录中打开终端或命令行。

  2. 2. 执行安装命令

    运行：npx killer-skills add DebVisor/PyAgent/elixir-docs-review。CLI 会自动识别 IDE 或 AI Agent 并完成配置。

  3. 3. 开始使用技能

    elixir-docs-review 已启用，可立即在当前项目中调用。

! 来源说明

此页面仍可作为安装与查阅参考。继续使用前，请结合上方适用场景、限制条件和上游仓库说明一起判断。

Upstream Repository Material

The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.

Upstream Source

elixir-docs-review

安装 elixir-docs-review，这是一款面向AI agent workflows and automation的 AI Agent Skill。查看功能、使用场景、限制条件与安装命令。

SKILL.md
Readonly
Upstream Repository Material
The section below comes from the upstream repository. Use it as supporting material alongside the fit, use-case, and installation summary on this page.
Upstream Source

Elixir Documentation Review

Quick Reference

Issue TypeReference
@moduledoc, @doc quality, anti-patternsreferences/doc-quality.md
@spec, @type, @typedoc coveragereferences/spec-coverage.md

Review Checklist

Module Documentation

  • All public modules have @moduledoc
  • First-line summary is concise (one line, used by tools as summary)
  • @moduledoc includes ## Examples where appropriate
  • @moduledoc false only on internal/implementation modules

Function Documentation

  • All public functions have @doc
  • All public functions have @spec
  • @doc describes return values clearly
  • Multi-clause functions documented before first clause
  • Function head declared when arg names need clarification

Doctests

  • Doctests present for pure, deterministic functions
  • No doctests for side-effectful operations (DB, HTTP, etc.)
  • Doctests actually run (module included in test file)

Cross-References

  • Module references use backtick auto-linking (MyModule)
  • Function refs use proper arity format (function/2)
  • Type refs use t: prefix (t:typename/0)
  • No plain-text references where auto-links are possible

Metadata

  • @since annotations on new public API additions
  • @deprecated with migration guidance where appropriate

Valid Patterns (Do NOT Flag)

  • @doc false on callback implementations - Documented at behaviour level
  • @doc false on protocol implementations - Protocol docs cover the intent
  • Missing @spec on private functions - @spec optional for internals
  • Short @moduledoc without ## Examples on simple utility modules - Not every module needs examples
  • Using @impl true without separate @doc - Inherits documentation from behaviour

Context-Sensitive Rules

IssueFlag ONLY IF
Missing @moduledocModule is public AND not a protocol impl
Missing @specFunction is public AND exported
Missing doctestsFunction is pure AND deterministic
Generic @docDoc restates function name without adding value

When to Load References

  • Reviewing @moduledoc or @doc quality, seeing anti-patterns -> doc-quality.md
  • Reviewing @spec, @type, or @typedoc coverage -> spec-coverage.md

Before Submitting Findings

Load and follow review-verification-protocol before reporting any issue.

相关技能

寻找 elixir-docs-review 的替代方案 (Alternative) 或可搭配使用的同类 community Skill？探索以下相关开源技能。

查看全部

openclaw-release-maintainer

Logo of openclaw
openclaw

本地化技能摘要： 🦞 # OpenClaw Release Maintainer Use this skill for release and publish-time workflow. It covers ai, assistant, crustacean workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 333.8k
⑂ 0
AI

widget-generator

Logo of f
f

本地化技能摘要： Generate customizable widget plugins for the prompts.chat feed system # Widget Generator Skill This skill guides creation of widget plugins for prompts.chat . It covers ai, artificial-intelligence, awesome-list workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf

★ 149.6k
⑂ 0
AI

flags

Logo of vercel
vercel

本地化技能摘要： The React Framework # Feature Flags Use this skill when adding or changing framework feature flags in Next.js internals. It covers blog, browser, compiler workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 138.4k
⑂ 0
浏览器

pr-review

Logo of pytorch
pytorch

本地化技能摘要： Usage Modes No Argument If the user invokes /pr-review with no arguments, do not perform a review . It covers autograd, deep-learning, gpu workflows. This AI agent skill supports Claude Code, Cursor, and Windsurf workflows.

★ 98.6k
⑂ 0
开发者工具