工作流程指南
了解 MyDeskBot 桌面应用的常见使用场景和工作流程,提高您的开发效率。
目录
日常工作流程
快速问答
场景: 快速获取信息或解决简单问题
步骤:
- 使用快捷键
Cmd+Shift+M(macOS) 或Ctrl+Shift+M(Windows/Linux) 打开面板 - 输入问题
- 按
Cmd+Enter发送 - 查看回答并复制需要的部分
示例:
如何在 JavaScript 中深拷贝一个对象?代码片段生成
场景: 快速生成常用代码片段
步骤:
- 打开 MyDeskBot 面板
- 描述需要的代码功能
- 指定编程语言(可选)
- 复制生成的代码
示例提示:
写一个 Python 函数,读取 CSV 文件并返回数据帧文本处理和编辑
场景: 文档编辑、格式转换、内容润色
步骤:
- 复制需要处理的文本
- 在 MyDeskBot 中粘贴
- 描述需要的处理方式
- 获取结果
示例提示:
请将以下文本翻译成英文,保持专业语调:
[粘贴文本]开发工作流程
代码审查辅助
场景: 审查代码或改进现有代码
步骤:
- 复制需要审查的代码
- 使用代码审查指令
- 查看建议和改进方案
- 应用有价值的建议
示例提示:
请审查以下代码,指出潜在问题和改进建议:
```typescript
function fetchData(url: string) {
fetch(url)
.then(res => res.json())
.then(data => console.log(data));
}
**获得反馈**:
- 添加错误处理
- 使用 async/await 语法
- 添加类型定义
- 处理响应验证
### Bug 调试
**场景**: 快速定位和解决代码错误
**步骤**:
1. 复制错误信息和相关代码
2. 描述问题和上下文
3. 分析 AI 提供的可能原因
4. 尝试建议的解决方案
**示例提示**:我的代码报错:TypeError: Cannot read properties of undefined
代码如下: [粘贴代码]
可能的原因是什么?如何修复?
### 代码重构
**场景**: 改进代码结构和可维护性
**步骤**:
1. 复制需要重构的代码
2. 说明重构目标
3. 评估重构建议
4. 分步应用改进
**示例提示**:请重构以下代码,提高可读性和可维护性:
[粘贴复杂的嵌套函数]
要求:
- 提取重复逻辑
- 使用更清晰的变量名
- 添加适当的注释
### API 集成
**场景**: 集成第三方 API 或服务
**步骤**:
1. 描述需要集成的 API
2. 请求示例代码
3. 了解认证和使用方式
4. 根据需求调整
**示例提示**:我想在 Node.js 项目中使用 Stripe API 处理支付。
请提供:
- 安装依赖的命令
- 初始化配置的代码
- 创建支付意图的示例
- 处理 webhooks 的代码
## 数据分析工作流程
### 数据库查询
**场景**: 编写和优化 SQL 查询
**步骤**:
1. 使用数据库客户端连接
2. 描述数据需求
3. 获取 SQL 查询语句
4. 在数据库中执行
5. 根据结果调整
**示例提示**:我有一个用户表,包含字段:id, name, email, created_at, status
请写一个 SQL 查询:
- 统计每月新增用户数
- 按用户状态分组
- 返回最近 6 个月的数据
### 数据可视化建议
**场景**: 选择合适的图表类型
**步骤**:
1. 描述数据结构和目标
2. 询问可视化建议
3. 获取图表配置代码
4. 集成到项目中
**示例提示**:我有以下数据:
- 每日销售额
- 产品类别
- 地区分布
请建议最合适的数据可视化方案,并提供 Chart.js 的实现代码。
## 自动化工作流程
### 创建脚本自动化任务
**场景**: 将重复性操作自动化
**步骤**:
1. 描述需要自动化的任务
2. 获取脚本代码
3. 保存到本地
4. 测试脚本
5. 设置定时任务
**示例提示**:请创建一个 Shell 脚本,实现以下功能:
- 备份 MySQL 数据库
- 压缩备份文件
- 上传到 AWS S3
- 删除 7 天前的备份
### 工作流集成
**场景**: 集成到 CI/CD 流程
**步骤**:
1. 了解 CI/CD 平台
2. 请求配置文件
3. 添加到项目
4. 测试工作流
**示例提示**:请为我的 Node.js 项目创建 GitHub Actions 工作流:
要求:
- 在 push 到 main 分支时触发
- 运行测试
- 构建项目
- 部署到 Vercel
## 最佳实践
### 提示词工程
#### 1. 明确具体
**❌ 不好的提示**:帮我写个函数
**✅ 好的提示**:用 Python 写一个函数,计算两个日期之间的工作日数量(排除周末和节假日)。
#### 2. 提供上下文
**❌ 不好的提示**:为什么这个代码慢?
**✅ 好的提示**:以下代码处理 1000 条记录需要 5 秒,太慢了。
// [粘贴代码]数据结构:数组包含用户对象,每个对象有 5 个字段。 目标:将处理时间降低到 1 秒以内。
#### 3. 指定输出格式
**❌ 不好的提示**:分析这段代码
**✅ 好的提示**:请以以下格式分析代码:
- 问题列表(用数字标号)
- 优先级(高/中/低)
- 修复建议(每个问题一段)
- 重构后的完整代码
// [粘贴代码]
#### 4. 迭代改进第一轮:生成基础代码 第二轮:添加错误处理 第三轮:添加单元测试 第四轮:优化性能
### 效率技巧
#### 使用快捷键
- `Cmd+Shift+M` / `Ctrl+Shift+M`: 快速打开面板
- `Cmd+N` / `Ctrl+N`: 新建对话
- `Cmd+L` / `Ctrl+L`: 清空对话
- `Cmd+Enter` / `Ctrl+Enter`: 发送消息
#### 保存常用提示
将常用的提示词保存为模板,可以快速复用:
```bash
# 代码审查模板
代码审查:
```[LANGUAGE]
[CODE]请检查:
- 代码质量
- 潜在 bug
- 性能问题
- 改进建议
#### 使用多轮对话
对于复杂任务,使用多轮对话逐步完成:第1轮:设计架构 第2轮:实现核心功能 第3轮:添加边界情况处理 第4轮:编写测试
### 安全实践
#### 敏感信息处理
**❌ 不要这样**:我的 API 密钥是 sk-1234567890abcdef,请帮我调试
**✅ 应该这样**:我有 API 调用返回 401 错误,可能的原因是什么? 代码中使用的是标准认证方式,密钥已正确配置。
#### 代码审查原则
- 不要直接运行未审查的代码
- 在测试环境验证后再应用到生产环境
- 注意安全漏洞(SQL 注入、XSS 等)
## 工作流模板
### 1. 新功能开发需求分析 → 描述功能需求 → 确认技术方案
设计 → 请求架构设计 → 讨论接口定义
开发 → 生成骨架代码 → 实现核心逻辑 → 添加错误处理
测试 → 编写单元测试 → 进行集成测试
部署 → 准备部署清单 → 编写部署文档
### 2. Bug 修复问题定位 → 复制错误信息 → 提供相关代码 → 描述重现步骤
原因分析 → 分析可能原因 → 验证假设
修复方案 → 请求修复建议 → 评估方案
验证 → 应用修复 → 编写回归测试 → 确认问题解决
### 3. 代码审查初步审查 → 检查代码风格 → 识别明显问题
深入分析 → 检查逻辑正确性 → 评估性能影响 → 检查安全问题
改进建议 → 提供具体建议 → 解释原因 → 提供示例
跟进 → 确认建议是否采纳 → 验证修改效果
## 常见场景快速参考
| 场景 | 推荐提示词 |
|------|-----------|
| 学习新技术 | "请用 [语言] 解释 [概念],并提供一个简单的示例" |
| 代码优化 | "请优化以下代码的性能:[代码]" |
| 添加注释 | "为以下代码添加详细的注释:[代码]" |
| 编写测试 | "为以下函数编写单元测试:[代码]" |
| 转换语言 | "将以下 [语言1] 代码转换为 [语言2]:[代码]" |
| 生成文档 | "为以下 API 生成使用文档:[代码]" |
## 下一步
- [安装指南](./installation.md) - 开始使用 MyDeskBot
- [配置指南](./configuration.md) - 定制您的体验
- [功能文档](../features/) - 探索更多功能
## 获取帮助
- [故障排除](../../shared/troubleshooting.md)
- [社区论坛](https://community.mydeskbot.ai)
- [GitHub Issues](https://github.com/mydeskbot/issues)