用途:为刚实现并已测试的 Elixir 功能生成文档,属于 /phx 工作流中可选的一步(建议在评审通过后执行)。用法示例:/phx:document .claude/plans/magic-link-auth/plan.md、/phx:document magic link authentication,或 /phx:document 从最近计划自动识别。
主要能力:为新模块补 @moduledoc,为无文档的公共函数补 @doc,为用户可见功能增加 README 章节,为重要架构决策编写 ADR。触发 ADR 的情形包括新增外部依赖、新增 OTP 进程、新增认证机制、性能优化等,新增数据库表或新 context 视情况而定。
约束原则:不删除已有文档,只更新而非替换;每个公共模块都要有 @moduledoc;ADR 记录“为什么”而非“是什么”;@doc 需覆盖参数、返回值与边界情况;不给未测试代码添加 @doc。
流程:先执行 git diff --name-only HEAD~5 | grep '.ex$' | head -20 检查是否有新 .ex 文件,若无新增模块则跳过完整审查并报告文档覆盖无变化;随后从近期提交或计划文件识别新模块、检查文档覆盖、按模板生成、必要时补 README 与 ADR,并将报告写入 .claude/plans/{slug}/reviews/{feature}-docs.md。模板与最佳实践位于 ${CLAUDE_SKILL_DIR}/references/ 下的 doc-templates.md、output-format.md、doc-best-practices.md、documentation-patterns.md。不适用于文档查询、文档审计或评审。