- 从服务器拉取完整代码 - 按框架规范整理项目结构 - 配置 Drone CI 测试环境部署 - 包含后端(FastAPI)、前端(Vue3)、管理端 技术栈: Vue3 + TypeScript + FastAPI + MySQL
208 lines
5.0 KiB
Markdown
208 lines
5.0 KiB
Markdown
# 子Agent快速使用指南
|
||
|
||
## 1. 在Cursor中使用Agent
|
||
|
||
### 方式一:作为系统提示词
|
||
1. 打开Cursor的设置
|
||
2. 找到"AI"或"Assistant"设置
|
||
3. 将Agent的`prompt.md`内容复制到系统提示词
|
||
4. 添加相关的context文件作为参考
|
||
|
||
### 方式二:在对话中引用(推荐)
|
||
|
||
#### 完整引用(包含架构文档 - 最推荐)
|
||
```
|
||
# 基础规范
|
||
@子agent/00-通用基础/base_prompt.md
|
||
@子agent/00-通用基础/essential_docs.md
|
||
|
||
# 架构设计(重要)
|
||
@考培练系统规划/后端开发拆分策略/协作机制设计.md
|
||
@考培练系统规划/后端开发拆分策略/模块分工指南.md
|
||
|
||
# Agent特定文档
|
||
@子agent/01-Agent-Auth/prompt.md
|
||
@子agent/01-Agent-Auth/context.md
|
||
|
||
请按照Agent-Auth的角色开始开发认证模块
|
||
```
|
||
|
||
#### 标准引用(一般情况)
|
||
```
|
||
@子agent/00-通用基础/base_prompt.md
|
||
@子agent/01-Agent-Auth/prompt.md
|
||
@子agent/01-Agent-Auth/context.md
|
||
|
||
请按照Agent-Auth的角色开始开发认证模块
|
||
```
|
||
|
||
**注意**:
|
||
- 完整引用能让Agent更好地理解项目架构和协作机制
|
||
- 每个Agent的context.md现在都包含了对重要规划文档的引用
|
||
- 但在对话中明确包含这些文档可以确保Agent完全理解所有设计决策
|
||
|
||
### 方式三:创建专门的工作空间
|
||
1. 为每个Agent创建独立的Cursor工作空间
|
||
2. 将Agent文件夹的内容复制进去
|
||
3. 设置.cursorrules文件指向prompt.md
|
||
|
||
## 2. 开发顺序建议
|
||
|
||
```mermaid
|
||
graph TD
|
||
A[1. Agent-Auth<br/>认证授权] --> B[2. Agent-User<br/>用户管理]
|
||
A --> C[3. Agent-Coze<br/>Coze集成]
|
||
A --> D[4. Agent-Dify<br/>Dify集成]
|
||
B --> E[5. Agent-Course<br/>课程管理]
|
||
C --> F[6. Agent-Training<br/>AI陪练]
|
||
D --> G[7. Agent-Exam<br/>考试模块]
|
||
E --> H[8. Agent-Analytics<br/>数据分析]
|
||
F --> H
|
||
G --> H
|
||
B --> I[9. Agent-Admin<br/>系统管理]
|
||
```
|
||
|
||
## 3. 快速启动检查清单
|
||
|
||
### 启动Agent前
|
||
- [ ] 确认项目脚手架已创建
|
||
- [ ] 数据库已配置并运行
|
||
- [ ] 已创建feature分支
|
||
- [ ] 已阅读通用基础规范
|
||
|
||
### 启动Agent时
|
||
```markdown
|
||
我是[Agent名称],我需要:
|
||
1. 查看我的prompt.md了解职责
|
||
2. 查看context.md了解项目结构
|
||
3. 查看api_contract.yaml了解接口规范
|
||
4. 查看examples/目录的示例代码
|
||
5. 按照checklist.md开始开发
|
||
```
|
||
|
||
### Agent工作时
|
||
- 先创建数据模型
|
||
- 再创建Schema
|
||
- 然后实现Service
|
||
- 最后完成API路由
|
||
- 同步编写测试
|
||
|
||
## 4. 常见问题处理
|
||
|
||
### Q: Agent不了解项目结构
|
||
A: 提供以下上下文:
|
||
```
|
||
项目根目录: /Users/nongjun/Desktop/Ai公司/本地开发与测试/kaopeilian-backend/
|
||
查看: @子agent/00-通用基础/project_structure.md
|
||
```
|
||
|
||
### Q: Agent不遵循代码规范
|
||
A: 提醒查看:
|
||
```
|
||
请严格遵循: @子agent/00-通用基础/base_prompt.md
|
||
特别注意代码规范部分
|
||
```
|
||
|
||
### Q: Agent创建了错误的导入路径
|
||
A: 明确指出:
|
||
```
|
||
所有导入都应该从app开始,例如:
|
||
from app.core.deps import get_db
|
||
from app.models.user import User
|
||
```
|
||
|
||
### Q: Agent忘记依赖关系
|
||
A: 查看依赖文档:
|
||
```
|
||
查看: @子agent/[Agent编号]/dependencies.md
|
||
确保正确导入和使用依赖模块的功能
|
||
```
|
||
|
||
## 5. 集成测试节点
|
||
|
||
### 第一个集成点:Auth + User
|
||
```bash
|
||
# 测试认证功能
|
||
pytest tests/integration/test_auth_user.py
|
||
|
||
# 验证要点:
|
||
- 用户注册后能登录
|
||
- Token能正确识别用户
|
||
- 权限检查正常工作
|
||
```
|
||
|
||
### 第二个集成点:Course + Exam + Training
|
||
```bash
|
||
# 测试业务功能
|
||
pytest tests/integration/test_business_modules.py
|
||
|
||
# 验证要点:
|
||
- 课程创建后能生成考题
|
||
- 陪练场景能关联课程
|
||
- 数据正确流转
|
||
```
|
||
|
||
### 最终集成:Analytics
|
||
```bash
|
||
# 测试数据分析
|
||
pytest tests/integration/test_analytics.py
|
||
|
||
# 验证要点:
|
||
- 能聚合各模块数据
|
||
- 报表生成正确
|
||
- 性能符合要求
|
||
```
|
||
|
||
## 6. 提交规范
|
||
|
||
### 每个Agent完成后
|
||
1. 运行所有代码检查
|
||
2. 确保测试通过
|
||
3. 更新集成状态
|
||
4. 提交格式:
|
||
```
|
||
feat(auth): 完成认证授权模块
|
||
|
||
- 实现用户登录、注册、登出功能
|
||
- 添加JWT Token管理
|
||
- 实现权限检查中间件
|
||
- 完成所有单元测试
|
||
- 测试覆盖率: 85%
|
||
|
||
Closes #[issue-number]
|
||
```
|
||
|
||
## 7. 调试技巧
|
||
|
||
### 查看Agent生成的代码
|
||
```python
|
||
# 在生成的代码中添加
|
||
print("=== Agent-Auth Generated ===")
|
||
# 你的代码
|
||
print("=== End of Generation ===")
|
||
```
|
||
|
||
### 验证API是否正确注册
|
||
```python
|
||
# 在main.py中添加
|
||
for route in app.routes:
|
||
print(f"{route.methods} {route.path}")
|
||
```
|
||
|
||
### 检查依赖注入
|
||
```python
|
||
# 测试依赖是否工作
|
||
@router.get("/test-auth")
|
||
async def test_auth(user: User = Depends(get_current_user)):
|
||
return {"user_id": user.id, "username": user.username}
|
||
```
|
||
|
||
## 8. 优化建议
|
||
|
||
1. **让Agent分步工作**:不要一次要求太多,分步骤进行
|
||
2. **提供明确的示例**:使用examples目录的代码作为参考
|
||
3. **及时纠正错误**:发现问题立即指出并提供正确示例
|
||
4. **保存好的输出**:将优秀的代码保存到examples中供后续参考
|
||
|
||
祝开发顺利! 🚀
|