快速开始指南

🚀 5 分钟快速上手

第 1 步：安装依赖

cd /path/to/SOP
pip install -r requirements.txt

第 2 步：生成 Excel 报告

方式一：从 Markdown 自动生成（推荐）

python generate_excel.py --markdown sop-003-product-creation-e2e.md

✅ 优势： - 完全自动化，无需维护代码中的数据 - 文档和 Excel 保持一致 - 支持任意多个任务

方式二：使用默认数据

python generate_excel.py

第 3 步：查看生成的 Excel 文件

生成的文件格式：{前缀}_{时间戳}.xlsx

例如：CRM产品创建E2E测试SOP_20251222_143022.xlsx

📋 常见使用场景

场景 1：为不同的 SOP 生成 Excel

# 产品创建 SOP
python generate_excel.py -m sop-003-product-creation-e2e.md -o "产品测试"

# 客户创建 SOP  
python generate_excel.py -m sop-001-customer-creation-e2e.md -o "客户测试"

# 政策标签 SOP
python generate_excel.py -m sop-101-policy-label-create.md -o "政策测试"

场景 2：为不同环境生成报告

# 开发环境
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  -o "DEV-产品测试" \
  -u "http://localhost:3000/crm"

# UAT 环境
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  -o "UAT-产品测试" \
  -u "https://uat.example.com/crm"

# 生产环境
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  -o "PROD-产品测试" \
  -u "https://prod.example.com/crm"

场景 3：包含截图列

# 默认不包含截图，如需截图列添加 --with-screenshots
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  --with-screenshots

场景 4：自定义截图目录

python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  -s "my_custom_screenshots"

🎨 自定义样式

# 更改表头颜色
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  --header-color "#FF5733"

# 调整字体大小
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  --title-font-size 16 \
  --checkbox-font-size 18

# 包含截图列（默认不包含）
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  --with-screenshots

# 包含截图并调整图片显示
python generate_excel.py \
  -m sop-003-product-creation-e2e.md \
  --with-screenshots \
  --image-scale-x 0.3 \
  --image-scale-y 0.3 \
  --row-height 100

📖 Markdown 文件格式

脚本会自动识别以下格式的内容：

任务标题

### 任务 T1：环境与账号验证

前置条件

入口：`http://localhost:3000/crm`

或

前置条件：T1 成功且当前在产品列表

任务表格

| Action Steps | Input / Payload | 预期结果 | 验证方式 | 证据 | 状态 | 下游任务 |
|--------------|----------------|----------|----------|------|------|----------|
| 步骤1：... | ... | ... | ... | ... | `[ ]` | 步骤 2 |

🔍 查看帮助

python generate_excel.py --help

📚 更多文档

❓ 常见问题

Q1: 如何批量生成多个 Excel？

A: 使用 shell 脚本循环：

for sop in sop-*.md; do
  python generate_excel.py -m "$sop" -o "${sop%.md}"
done

Q2: 为什么没有截图列？

A: 从版本 3.1 开始，默认不生成截图列。如需截图列，添加 --with-screenshots 参数：

python generate_excel.py -m sop-003.md --with-screenshots

Q3: 截图找不到怎么办？

A: （仅在使用 --with-screenshots 时）确保截图文件放在正确的目录，并按照命名规则： - 使用 markdown 时：{screenshot_dir}/T{任务编号}-step{步骤编号}.png - 例如：screenshots/T1-step1.png

Q4: 如何修改生成的 Excel 样式？

A: 使用样式参数： - --header-color：表头颜色 - --title-font-size：标题字体大小 - --checkbox-font-size：复选框字体大小

Q5: Markdown 解析失败怎么办？

A: 1. 检查任务标题格式：### 任务 T{编号}：{标题} 2. 确保表格格式正确（至少 7 列） 3. 查看控制台调试信息 4. 参考现有的 SOP 文档格式

💡 最佳实践

  1. 使用 Markdown 输入：保持文档和 Excel 同步
  2. 规范命名：使用有意义的输出文件名前缀
  3. 统一截图：按照命名规则组织截图文件
  4. 版本控制：将生成的 Excel 文件加入版本控制

🎉 开始使用

# 立即生成你的第一个 Excel 报告！
python generate_excel.py --markdown sop-003-product-creation-e2e.md