Bosch_Demo/crewai
4
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
80d9b50587f8d02c19ee785e6b4dad767d986c8a
crewai/generated_output/README.md
ZhuJW 80d9b50587 第一次提交
2026-03-13 14:20:58 +08:00

4.3 KiB
Raw Blame History

生成的代码和文档

本目录包含多智能体系统自动生成的所有产出物。

📁 目录结构

每次任务执行后，会在 task_YYYYMMDD_HHMMSS/ 子目录中生成以下文件：

task_20260313_140000/
├── PRD_产品需求文档.md      # 产品经理输出的需求文档
├── QA_测试计划.md          # QA 工程师输出的测试计划
├── Dev_技术方案.md         # 软件工程师输出的技术方案
├── Final_交付报告.md       # 协调员输出的最终交付报告
└── events_log.json        # 完整的事件日志（JSON 格式）

📄 文档说明

1. PRD_产品需求文档.md

内容包含：

  • 项目概述（背景、目标用户、核心价值）
  • 功能需求列表（P0/P1/P2优先级）
  • 用户故事和用例
  • 验收标准
  • 风险评估和缓解措施

示例片段：

# 产品需求文档

## 1. 项目概述
### 1.1 项目背景
随着...的发展，需要一个...系统

### 1.2 目标用户
- 主要用户群体：...
- 次要用户群体：...

## 2. 功能需求
### P0 - 核心功能
1. 用户注册与登录
2. CRUD 操作
...

2. QA_测试计划.md

内容包含：

  • 测试策略（单元测试、集成测试、E2E 测试）
  • 详细测试用例
  • 性能测试方案
  • 自动化测试建议

示例片段：

# 测试计划

## 1. 测试策略
### 1.1 单元测试
- 覆盖核心业务逻辑
- 目标覆盖率：80%+

## 2. 测试用例
### TC-001: 用户注册
**前置条件**: 无
**步骤**:
1. 访问注册页面
2. 填写表单
...

3. Dev_技术方案.md

内容包含：

  • 系统架构设计
  • 技术栈选择及理由
  • 数据库 Schema 设计
  • API 接口定义
  • 核心代码实现
  • 部署方案

示例片段：

# 技术方案

## 1. 架构设计
### 1.1 整体架构
采用前后端分离的 RESTful 架构

### 1.2 技术栈
- 后端：FastAPI + SQLAlchemy
- 数据库：SQLite/PostgreSQL
- 前端：Vue.js/React

## 2. 数据库设计
### User 表
| 字段 | 类型 | 说明 |
|------|------|------|
| id | INTEGER | 主键 |
| username | VARCHAR(50) | 用户名 |
...

4. Final_交付报告.md

内容包含：

  • 交付摘要
  • 一致性检查（PRD↔测试计划↔技术方案）
  • 质量评估（完整性、可行性评分）
  • 风险提示
  • 后续行动建议

示例片段：

# 最终交付报告

## 1. 交付摘要
本项目已完成以下交付物：
- ✓ PRD 文档（版本 1.0）
- ✓ 测试计划（版本 1.0）
- ✓ 技术方案（版本 1.0）

## 2. 质量评估
### 完整性评分：8.5/10
优点：
- 需求描述清晰
- 测试覆盖全面

改进点：
- 部分边界情况未考虑
...

🔍 如何查看

Windows 用户

# 打开最新生成的目录
explorer (Get-ChildItem . -Directory | Sort-Object LastWriteTime -Descending | Select-Object -First 1).FullName

Mac/Linux 用户

# Mac
open $(ls -td task_* | head -n1)

# Linux
xdg-open $(ls -td task_* | head -n1)

通用方法

直接在文件管理器中浏览本目录，找到对应时间戳的文件夹。

💾 文件格式说明

  • Markdown (.md): 可用任何文本编辑器或 Markdown 阅读器打开
    • 推荐工具：VS Code、Typora、Obsidian
  • JSON (.json): 结构化事件日志，可用于程序处理
    • 可用浏览器、文本编辑器或 JSON 查看器打开

📊 文件大小参考

典型任务的输出文件大小：

  • PRD 文档：10-30 KB
  • 测试计划：15-40 KB
  • 技术方案：20-50 KB
  • 交付报告：10-25 KB
  • 事件日志：5-15 KB

⚠️ 注意事项

  1. 及时备份: 生成的文件存储在本地，请定期备份重要文档
  2. 版本管理: 建议将生成的文档纳入 Git 版本控制
  3. 敏感信息: 注意不要泄露 API Key 等敏感信息
  4. 磁盘空间: 长期运行会产生大量文件，定期清理旧文件

🎯 使用建议

  1. 审查生成内容: AI 生成的内容可能有误，务必人工审查
  2. 迭代优化: 根据实际反馈调整需求描述，重新生成
  3. 团队协作: 将生成的文档作为讨论基础，团队共同完善
  4. 知识沉淀: 将优秀实践固化到需求模板中

开始使用: 运行 python ../example_usage.py 或访问 http://localhost:8000/test-ui