intent-report

Intent Report

Convert technical Intent files into human-readable report documents.

Purpose

• For Stakeholders: project overview, progress, key decisions
• For New Members: quickly understand the project architecture and design rationale
• For Documentation: generate README, design documents, architecture descriptions
• For Meetings: project reports, technical reviews

Workflow

/intent-report [options]
        ↓
┌───────────────────────────────────┐
│  读取 Intent 文件                  │
│  - 项目级 + 模块级                 │
│  - 解析结构和元数据                │
└─────────────┬─────────────────────┘
              ↓
┌───────────────────────────────────┐
│  确定报告类型                      │
│  - overview / architecture /      │
│    progress / full                │
└─────────────┬─────────────────────┘
              ↓
┌───────────────────────────────────┐
│  生成报告                          │
│  - 重组内容结构                    │
│  - 转换技术语言                    │
│  - 添加可视化                      │
└─────────────┬─────────────────────┘
              ↓
┌───────────────────────────────────┐
│  输出                              │
│  - Markdown / HTML / PDF          │
│  - 写入文件 or 直接展示            │
└───────────────────────────────────┘

Report Types

1. Overview

/intent-report --type overview

A one-page project overview, suitable for a quick understanding:

# [Project] Overview

## What is this?
[一句话说明]

## Problem
[要解决的问题]

## Solution
[解决方案概述]

## Architecture
[简化的架构图]

## Key Modules
| Module | Purpose |
|--------|---------|

## Status
[当前状态和下一步]

2. Architecture

/intent-report --type architecture

Detailed architecture document, suitable for technical reviews:

# [Project] Architecture

## System Overview
[架构图]

## Module Dependencies
[依赖关系图]

## Data Flow
[数据流图]

## Key Design Decisions
| Decision | Choice | Rationale |

## Boundary Rules
[模块边界规则]

## API Reference
[核心 API 列表]

3. Progress

/intent-report --type progress

Project progress report, suitable for reporting:

# [Project] Progress Report

> Generated: YYYY-MM-DD

## Intent Coverage
[覆盖率图表]

## Module Status
| Module | Intent | Impl | Status |
|--------|--------|------|--------|
| core   | ✓      | 80%  | 🟡     |

## Recent Updates
[最近的 Intent 变更]

## Approval Status
- Locked: N sections
- Reviewed: M sections
- Draft: K sections

## Blockers & Risks
[风险和阻塞项]

## Next Steps
[下一步计划]

4. Full

/intent-report --type full

Complete technical document, including all content.

Output Format

Markdown (default)

/intent-report -o report.md

HTML

/intent-report --format html -o report.html

Styled HTML document, viewable directly in a browser.

Console (display directly)

/intent-report

When no output file is specified, display directly in the terminal.

Usage Examples

Generate project overview

/intent-report --type overview

Generate architecture document for new members

/intent-report --type architecture -o docs/ARCHITECTURE.md

Generate progress report for stakeholders

/intent-report --type progress -o reports/progress-2026-01.md

Generate a single-module report

/intent-report src/core/ --type full

Content Conversion Rules

Technical language → human language

In Intent	In report
## 职责	"What this module does"
## 非目标	"Out of scope"
## 约束	"Constraints & Rules"
::: locked	"Core Architecture (frozen)"
::: reviewed	"Approved Design"
::: draft	"Work in Progress"

ASCII diagram → visualization

• Keep ASCII diagram (good compatibility)
• Optional: convert to Mermaid diagram (--mermaid option)

Working with Other Commands

/intent-init              # 初始化
    ↓
/intent-interview         # 创建 Intent
    ↓
/intent-review            # 审批
    ↓
/intent-report            # ← 生成报告（本命令）
    ↓
分享给 stakeholder / 团队

Advanced Options

/intent-report
  --type <type>           # overview | architecture | progress | full
  --format <format>       # markdown | html
  --output <path>         # 输出文件路径
  --module <path>         # 指定模块
  --include-draft         # 包含 draft sections
  --mermaid               # 转换为 Mermaid 图
  --lang <lang>           # 输出语言 (en | zh)