9.5 KiB
9.5 KiB
OpenClaw多Agent系统文档索引
系统概述
核心文档
| 文档 | 描述 | 重要性 | 最后更新 |
|---|---|---|---|
| 多Agent项目设计文档.md | 系统架构和设计文档 | ★★★★★ | 2026-03-31 |
| 使用手册.md | 完整用户操作指南 | ★★★★★ | 2026-03-31 |
| AGENTS.md | 协作规则和角色定义 | ★★★★☆ | 2026-03-28 |
| README.md | 项目概览和快速开始 | ★★★★☆ | 2026-03-31 |
开发文档
| 文档 | 描述 | 重要性 | 最后更新 |
|---|---|---|---|
| 开发计划.md | 开发任务和时间计划 | ★★★★☆ | 2026-03-31 |
| 消息路由系统设计.md | 消息系统详细设计 | ★★★★☆ | 2026-03-31 |
| 启动指南.md | Agent启动和配置指南 | ★★★☆☆ | 2026-03-31 |
测试文档
| 文档 | 描述 | 重要性 | 最后更新 |
|---|---|---|---|
| 测试用例.md | 完整测试用例列表 | ★★★★☆ | 2026-03-31 |
| 测试执行记录.md | 测试过程和结果记录 | ★★★☆☆ | 2026-03-31 |
| 测试总结报告.md | 测试结论和建议 | ★★★★☆ | 2026-03-31 |
快速开始指南
第一步:系统检查
# 运行系统状态检查
系统状态.bat
# 检查Agent配置
openclaw agents list
第二步:启动系统
# 一键启动所有Agent
一键启动所有.bat
# 或单独启动
启动-pm.bat
启动-backend.bat
启动-frontend.bat
启动-qa.bat
第三步:发送消息
# 使用批处理文件
发送消息.bat PM "查看当前任务"
发送消息.bat BE "开始开发接口"
# 或直接使用OpenClaw命令
openclaw agent --agent pm --message "[PM] 创建新任务"
第四步:管理项目
# 查看任务
openclaw agent --agent pm --message "[PM] 列出所有任务"
# 创建新任务
openclaw agent --agent pm --message "[PM] 创建任务:新功能开发"
# 查看测试报告
openclaw agent --agent qa --message "[QA] 查看最新测试报告"
目录结构说明
核心目录
D:\openclaw-multi-agent\
├── roles\ # 各角色工作空间
│ ├── pm\ # 产品经理
│ ├── dev-backend\ # 后端工程师
│ ├── dev-frontend\ # 前端工程师
│ ├── qa\ # 测试工程师
│ └── ... (其他12个角色)
├── shared\ # 共享工作空间
│ ├── tasks\ # 任务池
│ ├── specs\ # 需求文档
│ ├── code\ # 代码文件
│ ├── reports\ # 测试报告
│ ├── designs\ # 设计稿
│ ├── memory\ # 共享记忆
│ └── notifications\ # 消息系统
├── scripts\ # 工具脚本
│ ├── message-router.js # 消息路由系统
│ └── send-message.js # 消息发送工具
└── *.md # 文档文件
配置文件位置
C:\Users\Administrator\.openclaw\openclaw.json # OpenClaw主配置
C:\Users\Administrator\.openclaw\agents\ # Agent配置目录
角色体系
核心角色(已配置)
| 角色 | Agent名称 | 工作空间 | 状态 |
|---|---|---|---|
| 产品经理 | pm | roles\pm | ✅ 已配置 |
| 后端工程师 | backend | roles\dev-backend | ✅ 已配置 |
| 前端工程师 | frontend | roles\dev-frontend | ✅ 已配置 |
| 测试工程师 | qa | roles\qa | ✅ 已配置 |
扩展角色(待配置)
| 角色 | Agent名称 | 工作空间 | 状态 |
|---|---|---|---|
| UI设计师 | ui-design | roles\ui-design | ⚠️ 目录存在 |
| DevOps工程师 | devops | roles\devops | ⚠️ 目录存在 |
| 销售 | sales | roles\sales | ⚠️ 目录存在 |
| CEO | ceo | roles\ceo | ⚠️ 目录存在 |
| ...其他12个角色 | ... | ... | ⚠️ 目录存在 |
工具脚本
批处理工具
| 脚本 | 功能 | 使用方法 |
|---|---|---|
| 一键启动所有.bat | 启动所有Agent | 双击运行 |
| 启动-pm.bat | 启动PM Agent | 双击运行 |
| 启动-backend.bat | 启动后端Agent | 双击运行 |
| 启动-frontend.bat | 启动前端Agent | 双击运行 |
| 启动-qa.bat | 启动QA Agent | 双击运行 |
| 发送消息.bat | 发送消息到Agent | 发送消息.bat PM "消息内容" |
| 系统状态.bat | 检查系统状态 | 双击运行 |
Node.js脚本
| 脚本 | 功能 | 使用方法 |
|---|---|---|
| scripts/message-router.js | 消息路由系统 | node message-router.js receive "[PM] 消息" |
| scripts/send-message.js | 消息发送工具 | node send-message.js test |
配置指南
Agent配置
# 查看已配置的Agent
openclaw agents list
# 添加新Agent
openclaw agents add <名称> --workspace <路径> --non-interactive
# 示例:添加UI设计师
openclaw agents add ui-design --workspace D:\openclaw-multi-agent\roles\ui-design --non-interactive
路由配置
# 查看路由绑定
openclaw agents bindings
# 绑定Agent到通道
openclaw agents bind pm --bind "webchat"
# 绑定多个通道
openclaw agents bind backend --bind "webchat:backend" --bind "telegram"
环境配置
# 设置环境变量(批处理文件)
set OPENCLAW_WORKSPACE=D:\openclaw-multi-agent\roles\pm
set OPENCLAW_DEFAULT_AGENT=pm
set OPENCLAW_LOG_LEVEL=info
工作流程示例
完整项目流程
1. 需求收集 → 2. 需求分析 → 3. 产品设计 → 4. 技术评审
↓ ↓ ↓ ↓
[客户/销售] [PM] [UI/UX] [CTO/开发]
↓
5. 开发实现 → 6. 测试验证 → 7. 部署上线 → 8. 运营维护
↓ ↓ ↓ ↓
[BE/FE] [QA] [DevOps] [CS/运营]
消息协作示例
# 1. PM创建需求
发送消息.bat PM "创建新需求:用户评论功能"
# 2. PM分配任务
发送消息.bat PM "将评论功能分配给后端和前端"
# 3. 后端开发
发送消息.bat BE "开始开发评论接口"
# 4. 前端开发
发送消息.bat FE "开始开发评论页面"
# 5. 测试验证
发送消息.bat QA "测试评论功能"
# 6. 验收上线
发送消息.bat PM "验收评论功能"
故障排除
常见问题
问题1:Agent无法启动
症状: Error: Agent not found
解决:
# 检查Agent配置
openclaw agents list
# 重新添加Agent
openclaw agents add pm --workspace D:\openclaw-multi-agent\roles\pm --non-interactive
问题2:消息发送失败
症状: 消息无响应或错误 解决:
# 检查OpenClaw状态
openclaw status
# 查看日志
openclaw logs
# 测试简单消息
openclaw agent --agent pm --message "[PM] 测试"
问题3:文件访问权限问题
症状: Permission denied 或文件无法访问
解决:
# 检查目录权限
icacls D:\openclaw-multi-agent
# 修复权限
icacls D:\openclaw-multi-agent /grant Users:(OI)(CI)F
调试工具
# 查看详细日志
openclaw logs --level debug
# 监控系统资源
系统状态.bat
# 测试消息路由
node scripts\send-message.js test
扩展开发
添加新角色
- 创建角色目录:
mkdir roles\新角色 - 创建SOUL.md和USER.md文件
- 添加Agent配置:
openclaw agents add 新角色 --workspace roles\新角色 - 创建启动脚本:参考
启动-pm.bat - 测试新角色:
openclaw agent --agent 新角色 --message "测试"
集成外部系统
- Git集成: 配置Git工作流,自动同步代码
- 飞书集成: 配置飞书机器人,接收消息
- 数据库集成: 连接MySQL/PostgreSQL数据库
- API集成: 调用外部REST API服务
性能优化
- 缓存优化: 启用消息缓存,减少重复处理
- 并发处理: 实现多线程消息处理
- 资源监控: 实时监控系统资源使用
- 自动扩展: 根据负载自动调整资源
维护计划
日常维护
- 每日检查系统状态
- 备份重要数据
- 清理临时文件
- 更新系统日志
每周维护
- 检查Agent配置
- 更新文档
- 性能优化
- 安全审计
每月维护
- 系统升级
- 数据归档
- 容量规划
- 灾难恢复测试
联系和支持
问题反馈
- 查看相关文档
- 运行诊断工具:
系统状态.bat - 查看日志:
openclaw logs - 联系维护团队
更新记录
| 日期 | 版本 | 更新内容 |
|---|---|---|
| 2026-03-31 | v1.0 | 系统基础架构完成,核心功能验证通过 |
| 2026-03-31 | v1.1 | 添加消息路由系统设计,完善文档 |
| 2026-03-31 | v1.2 | 创建工具脚本,优化启动流程 |
未来计划
- 实现完整的消息路由系统
- 添加更多角色Agent配置
- 集成外部工具和服务
- 优化系统性能和稳定性
索引版本: v1.0
创建时间: 2026-03-31 21:20
最后更新: 2026-03-31 21:20
维护者: 橙子(龙虾助手)🦞🍊
状态: 活跃维护中