用途:将技术性的 Intent 文件转换成人类可读的报告文档。适用对象包括给 Stakeholder 看项目概览、进度与关键决策,给新成员快速了解项目架构和设计理由,生成 README、设计文档、架构说明等文档,以及用于项目汇报和技术评审。
工作流程:先读取项目级与模块级 Intent 文件并解析结构和元数据,再确定报告类型,随后重组内容结构、转换技术语言、添加可视化,最后输出为 Markdown、HTML 或 PDF,可写入文件或直接展示。
报告类型:overview 为单页项目概览;architecture 为详细架构文档,含系统概览、模块依赖、数据流、关键设计决策、边界规则与核心 API;progress 为进度报告,含 Intent 覆盖率、模块状态、最近变更、审批状态、风险与下一步;full 为包含所有内容的完整技术文档。
使用方式:通过 /intent-report 调用。常用选项包括 --type 指定类型(overview | architecture | progress | full)、--format 指定格式(markdown | html)、--output 指定输出文件路径、--module 指定模块、--include-draft 包含 draft sections、--mermaid 转换为 Mermaid 图、--lang 指定输出语言(en | zh)。示例:/intent-report --type overview;/intent-report --type architecture -o docs/ARCHITECTURE.md;/intent-report --type progress -o reports/progress-2026-01.md;/intent-report src/core/ --type full。不指定输出文件时直接在终端展示。
内容转换规则:将技术语言转为人类语言,例如职责、非目标、约束分别对应 What this module does、Out of scope、Constraints & Rules;locked、reviewed、draft 分别显示为 Core Architecture (frozen)、Approved Design、Work in Progress。ASCII 图默认保留,可选转换为 Mermaid 图。
与其他命令配合:/intent-init 初始化,/intent-interview 创建 Intent,/intent-review 审批,/intent-report 生成报告,最后分享给 stakeholder 或团队。
限制:资料未提供具体安装步骤、收费方式、平台要求或报告效果保证,暂未提供。