openai-compatible-task-master
Version:
使用MCP解析PRD文档并生成任务列表
79 lines (63 loc) • 3.1 kB
Markdown
# OCTM CLI 最佳实践指南
## 1. 环境配置
创建 `.env.octm` 文件设置默认参数:
```
OPENAI_API_KEY=your_api_key_here
OPENAI_API_URL=https://api.openai.com/v1
OPENAI_MODEL=gpt-4
PRD_PATH=/examples/prd-example.md
TASKS_PATH=/tasks/tasks.json
NUM_TASKS=5
STREAM_MODE=true
LOG_LEVEL=info # 可选值: error/warn/info/debug，默认为 info
```
**重要** 不要用命令行或读取文件的工具读取 `.env.octm` 文件，否则会泄露你的 API Key。
**日志级别**: `error`(只显示错误信息), `warn`(显示警告和错误信息), `info`(显示一般信息、警告和错误，默认), `debug`(显示所有信息，包括调试信息)
在命令行中临时覆盖环境配置: `npx octm-cli parse-files --input example.md --log-level debug`
## 2. 多文件处理建议
- 确保多个PRD文件内容相关
- 使用"|"正确分隔文件路径
- 建议同时指定输出路径
## 3. 子任务管理最佳实践
- **合理分解任务**: 将复杂任务分解为5-7个子任务，每个子任务专注于单一职责
- **使用有意义的命名**: 为子任务指定清晰、具体的标题和描述
- **设置合理的优先级**: 根据依赖关系和紧急程度为子任务设置优先级
- **逐级完成**: 先完成高优先级的子任务，再处理低优先级的子任务
- **及时更新状态**: 完成子任务后立即更新状态，以便团队了解进度
- **避免过度分解**: 避免将任务分解得过细，导致管理开销增加
- **定期审查**: 定期审查子任务列表，确保任务分解合理且仍然符合项目目标
## 4. 提示(Prompt)编写最佳实践
为确保大模型能够更好地理解和执行任务更新或分解，提示内容应尽可能详细和结构化：
- **包含项目背景**: 简要说明项目目标、领域和关键特性
- **说明技术栈**: 列出项目使用的主要技术、框架和库
- **描述代码结构**: 提供代码库的组织结构，如主要目录、模块划分
- **指定架构模式**: 说明项目采用的架构模式(MVC、微服务等)和设计原则
- **明确任务边界**: 清晰界定任务的范围、输入和期望输出
- **提供参考示例**: 引用类似功能的现有代码作为参考
- **使用结构化格式**: 使用列表、分段等使提示更加清晰
- **指定特定需求**: 明确任何性能、安全、兼容性等非功能性需求
**示例结构**:
```
希望根据以下上下文更新/分解任务：
【项目背景】
- 项目名称和目标
- 用户群体和主要用例
【技术栈】
- 前端：框架/库/语言
- 后端：框架/语言/数据库
- 其他关键技术
【代码结构】
- 主要目录及其用途
- 核心模块及其职责
【架构说明】
- 整体架构模式
- 关键设计模式和原则
【任务需求】
- 具体功能点
- 性能/安全等特殊要求
- 与其他模块的交互方式
【参考示例】
- 类似功能的实现位置
```
在命令行中使用多行提示时，可以将提示内容保存在文件中并使用管道传入：
`cat prompt.txt | npx octm-cli update-tasks --prompt -`