name: phx:document
description: 为已实现的功能生成文档 - @moduledoc、README 更新、ADRs。在 /phx:review 通过后运行。
argument-hint: [计划文件 或 功能名称]
文档
为新实现的功能生成文档。
使用方法
/phx:document .claude/plans/magic-link-auth/plan.md
/phx:document 魔法链接认证
/phx:document # 从最近的计划自动检测
文档内容
| 输出 |
描述 |
@moduledoc |
用于缺少文档的新模块 |
@doc |
用于没有文档的公共函数 |
| README 部分 |
用于面向用户的功能 |
| ADR |
用于重要的架构决策 |
工作流程
- 识别 从最近的提交或计划文件中识别新模块
- 检查 文档覆盖率（
@moduledoc、@doc）
- 生成 使用模板生成缺失的文档
- 添加 如果是面向用户的功能，添加 README 部分
- 创建 如果做出了架构决策，创建 ADR
- 写入 报告到
.claude/plans/{slug}/reviews/{feature}-docs.md
何时生成 ADRs
| 触发条件 |
创建 ADR |
| 新的外部依赖 |
是 |
| 新的数据库表 |
可能（如果模式不明显） |
| 新的 OTP 进程 |
是（解释为什么需要进程） |
| 新的上下文 |
可能（如果边界不明显） |
| 新的认证机制 |
是 |
| 性能优化 |
是 |
与工作流程集成
/phx:plan → /phx:work → /phx:review
↓
/phx:document ← 您在此（可选，建议在审查通过后）
参考资料
references/doc-templates.md — @moduledoc、@doc、README、ADR 模板references/output-format.md — 文档报告格式references/doc-best-practices.md — Elixir 文档最佳实践references/documentation-patterns.md — 详细文档模式