orchestrix
Version:
Orchestrix - Universal AI Agent Framework for Coordinated AI-Driven Development
136 lines (96 loc) • 3.56 kB
Markdown
# Orchestrix 用户指南
## 什么是 Orchestrix?
Orchestrix 是一个通用AI代理框架,通过协调多个专业化AI代理来完成复杂项目开发。
### 核心优势
- 🎯 **专业化分工** - 每个代理专注特定领域,提高工作质量
- 📋 **标准化流程** - 8步标准工作流,确保项目成功交付
- 🔄 **上下文传递** - 信息在代理间无缝流转,避免重复沟通
## 快速开始
### 1. 安装配置
```bash
# 一键安装
npx orchestrix install
# 选择你的IDE(Cursor/VS Code/Windsurf等)
# 系统会自动配置开发环境
# 验证安装
npx orchestrix status
```
### 2. 选择工作模式
| 模式 | 适用场景 | 推荐平台 |
| ----------- | ------------------ | ------------------------- |
| **Web界面** | 项目规划、需求分析 | ChatGPT、Claude、Gemini |
| **IDE开发** | 代码实现、文件管理 | Cursor、VS Code、Windsurf |
### 3. 开始第一个项目
**Web界面快速开始:**
1. 下载团队配置文件:`team-fullstack.yaml`
2. 上传到AI平台
3. 输入 `*help` 查看可用命令
4. 使用 `*analyst` 开始项目分析
**IDE开发快速开始:**
```bash
# 在IDE中调用代理
@dev.mdc # Cursor
/dev # Claude Code
```
## 核心代理角色
### 规划阶段(Web界面推荐)
| 代理 | 输出文档 | 核心职责 |
| ------------- | ----------------- | ------------------ |
| **Analyst** | project-brief.md | 项目分析、市场调研 |
| **PM** | prd.md | 需求文档、功能规划 |
| **UX-Expert** | front-end-spec.md | UI/UX设计规范 |
| **Architect** | architecture.md | 技术架构设计 |
| **PO** | 质量验证 | 文档一致性检查 |
### 开发阶段(IDE推荐)
| 代理 | 主要任务 |
| ---------------- | ---------------------- |
| **Scrum Master** | 用户故事创建、任务管理 |
| **Architect** | 技术准确性审核 |
| **Dev** | 代码实现、功能开发 |
| **QA** | 代码审查、质量控制 |
## 标准工作流程
```
1. Analyst → 项目简介
2. PM → 需求文档
3. UX-Expert → UI规范
4. Architect → 架构设计
5. PM → 更新需求(基于架构反馈)
6. PO → 验证一致性
7. PO → 拆分文档
8. 开发迭代循环 → SM创建故事 → Architect审核 → Dev开发 → QA检查 → 循环
```
## 常用命令
### Web界面命令
```
*help # 查看帮助
*analyst # 切换分析师
*pm # 切换产品经理
*architect # 切换架构师
*kb-mode # 知识库模式
```
### CLI命令
```bash
npx orchestrix install # 安装/更新
npx orchestrix status # 查看状态
npx orchestrix list # 列出代理
```
## 最佳实践
### ✅ 推荐做法
- 按顺序使用代理,不要跳步骤
- Web界面做规划,IDE做开发
- 保持文档完整,便于代理间传递
- 一次只使用一个代理角色
### ❌ 避免事项
- 不要混用代理角色
- 不要跳过PO验证步骤
- 不要在同一会话中频繁切换代理
## 扩展功能
- 🎮 游戏开发扩展包
- ☁️ 基础设施DevOps包
- ✍️ 内容创作工具包
## 获取帮助
- 📚 详细文档:查看 `docs/` 目录其他指南
- 🔧 工作流程:参考 `03-工作流程指南.md`
- 🏗️ 架构说明:查看 `02-核心架构.md`
---
🚀 **开始你的第一个Orchestrix项目吧!记住:专业化分工是成功的关键。**