document

仓库创建 2026年2月12日最近提交 5 小时前SkillHot 收录 20 天前

▸ 精选理由

快速补全模块与函数文档，便于维护与交付新特性。

这个 Skill 做什么

为 Elixir 模块、contexts 和 schema 自动生成 @moduledoc/@doc 注释。

为新实现的 Elixir 模块、context 和 schema 自动生成或补全 @moduledoc/@doc，并能把相关说明同步到 README 或 ADR。常在功能刚落地、需要把设计意图和使用示例写进代码里时用到，减少遗漏。遵循“先更新不替换”的原则，优先保留历史文档并做增量修改，避免一键覆盖掉有价值的设计记录。

▸ 展开 SKILL.md 英文原文

Generate @moduledoc/@doc for tested Elixir features; may update their README section or ADR. Not for docs lookup, documentation audits/reviews, or capturing standalone decisions.

开发编程Elixir文档生成PhoenixClaude Code

505

Stars

Forks

仓库内 Skill

+35

7 日增星

安装 / 使用

给你的 Agent 一句话（通用）

帮我安装这个 skill：https://raw.githubusercontent.com/oliver-kriska/claude-elixir-phoenix/main/plugins/elixir-phoenix/skills/document/SKILL.md

或 curl 直取 SKILL.md

curl -fsSL "https://raw.githubusercontent.com/oliver-kriska/claude-elixir-phoenix/main/plugins/elixir-phoenix/skills/document/SKILL.md"

SKILL.MD 节选查看完整文件 ↗

# Document

Generate documentation for newly implemented features.

## Usage

```
/phx:document .claude/plans/magic-link-auth/plan.md
/phx:document magic link authentication
/phx:document  # Auto-detect from recent plan
```

## Iron Laws

1. **Never remove existing documentation** — Existing docs may reflect design intent that isn't obvious from code alone; update rather than replace
2. **@moduledoc on every public module** — Undocumented modules accumulate quickly and create onboarding friction for new team members
3. **ADRs capture the "why", not the "what"** — Code shows what was built; ADRs explain why this approach was chosen over alternatives
4. **Match @doc to function's public API**

via SKILL·HOT · 数据来自 GitHub 公开信息 · 原文版权归作者所有