Initial commit
This commit is contained in:
Zhongwei Li
259
codex-mcp/HANDOFF_CHECKLIST.md
Normal file
259
codex-mcp/HANDOFF_CHECKLIST.md
Normal file
@@ -0,0 +1,259 @@
|
||||
# Codex 任务交接检查清单
|
||||
|
||||
使用此检查清单确保向 Codex 提供所有必要信息。
|
||||
|
||||
## 任务评估
|
||||
|
||||
**复杂度**: ⬜ 简单 ⬜ 中等 ⬜ 复杂 ⬜ 非常复杂
|
||||
**核心逻辑行数**: ________
|
||||
**主要目标**: ⬜ 算法设计 ⬜ 架构评审 ⬜ 性能优化 ⬜ 代码审查
|
||||
**紧急度**: ⬜ 低 ⬜ 中等 ⬜ 高 ⬜ 关键
|
||||
|
||||
---
|
||||
|
||||
## 核心检查清单
|
||||
|
||||
### 1. 问题定义 ✓
|
||||
- [ ] 清晰的问题陈述
|
||||
- [ ] 定义成功标准
|
||||
- [ ] 建立范围边界
|
||||
- [ ] 记录已知限制
|
||||
|
||||
### 2. 上下文信息 ✓
|
||||
- [ ] 提供项目概览
|
||||
- [ ] 共享相关背景
|
||||
- [ ] 识别相关系统/组件
|
||||
- [ ] 提供历史背景
|
||||
|
||||
```markdown
|
||||
**项目**: [名称和用途]
|
||||
**组件**: [正在处理的部分]
|
||||
**用户**: [谁使用此功能/规模]
|
||||
**历史**: [当前实现存在的原因]
|
||||
```
|
||||
|
||||
### 3. 技术约束 ✓
|
||||
- [ ] 性能要求（延迟、吞吐量）
|
||||
- [ ] 资源限制（内存、CPU、存储）
|
||||
- [ ] 兼容性要求（版本、平台）
|
||||
- [ ] 依赖约束
|
||||
|
||||
```markdown
|
||||
⬜ 时间复杂度: 最大 O(?)
|
||||
⬜ 空间复杂度: 最大 O(?)
|
||||
⬜ 延迟目标: __ms
|
||||
⬜ 吞吐量目标: __req/sec
|
||||
⬜ 内存限制: __MB/GB
|
||||
⬜ 平台: [Linux/Windows/macOS/跨平台]
|
||||
⬜ 语言版本: [例如：Rust 1.70+, Python 3.11+]
|
||||
```
|
||||
|
||||
### 4. 代码上下文 ✓
|
||||
- [ ] 共享相关现有代码
|
||||
- [ ] 记录代码风格/约定
|
||||
- [ ] 提供依赖列表
|
||||
- [ ] 包含项目结构概览
|
||||
|
||||
### 5. 数据上下文 ✓
|
||||
- [ ] 指定输入数据格式
|
||||
- [ ] 提供输入大小/规模
|
||||
- [ ] 定义预期输出格式
|
||||
- [ ] 识别边界情况
|
||||
|
||||
```markdown
|
||||
**输入**:
|
||||
- 格式: [JSON/CSV/Binary/其他]
|
||||
- 大小: [典型和最大]
|
||||
- 模式: [结构定义]
|
||||
- 示例: [示例数据]
|
||||
|
||||
**输出**:
|
||||
- 格式: [预期结构]
|
||||
- 约束: [验证规则]
|
||||
```
|
||||
|
||||
### 6. 测试用例 ✓
|
||||
- [ ] 提供正常情况（3-5 个示例）
|
||||
- [ ] 识别边界情况
|
||||
- [ ] 指定错误情况
|
||||
- [ ] 性能基准（如果适用）
|
||||
|
||||
```markdown
|
||||
**正常情况**:
|
||||
1. 输入: [...] → 期望: [...]
|
||||
2. 输入: [...] → 期望: [...]
|
||||
|
||||
**边界情况**:
|
||||
1. 空输入 → 期望: [...]
|
||||
2. 单元素 → 期望: [...]
|
||||
3. 最大大小 → 期望: [...]
|
||||
|
||||
**错误情况**:
|
||||
1. 无效格式 → 期望: [错误处理]
|
||||
2. 空值 → 期望: [错误处理]
|
||||
```
|
||||
|
||||
### 7. 性能基线 ✓
|
||||
（适用于优化任务）
|
||||
- [ ] 当前性能指标
|
||||
- [ ] 包含分析数据
|
||||
- [ ] 识别瓶颈
|
||||
- [ ] 指定目标改进
|
||||
|
||||
```markdown
|
||||
**当前性能**:
|
||||
- 延迟: p50: __ms, p95: __ms, p99: __ms
|
||||
- 吞吐量: __ops/sec
|
||||
- 内存: __MB 峰值
|
||||
- CPU: __%
|
||||
|
||||
**瓶颈** (来自分析):
|
||||
1. 函数 X: __% 时间
|
||||
2. 函数 Y: __% 时间
|
||||
|
||||
**目标**:
|
||||
- 延迟减少 __%
|
||||
- 吞吐量增加到 __ops/sec
|
||||
```
|
||||
|
||||
### 8. 安全考虑 ✓
|
||||
- [ ] 敏感数据处理要求
|
||||
- [ ] 认证/授权需求
|
||||
- [ ] 合规要求（GDPR、HIPAA 等）
|
||||
- [ ] 已知安全关注点
|
||||
|
||||
### 9. 具体问题 ✓
|
||||
- [ ] 准备至少 2 个具体问题
|
||||
- [ ] 问题集中且可回答
|
||||
- [ ] 如果有多个问题则优先排序
|
||||
|
||||
### 10. 预期交付物 ✓
|
||||
- [ ] 明确界定您需要 Codex 做什么
|
||||
- [ ] 指定格式（伪代码、完整代码、设计文档）
|
||||
- [ ] 指示详细程度
|
||||
|
||||
```markdown
|
||||
⬜ 高级架构图
|
||||
⬜ 详细设计文档
|
||||
⬜ 伪代码/算法
|
||||
⬜ 实现代码
|
||||
⬜ 测试用例
|
||||
⬜ 性能分析
|
||||
⬜ 权衡比较
|
||||
⬜ 迁移策略
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 任务特定检查清单
|
||||
|
||||
### 算法设计任务
|
||||
- [ ] 问题约束形式化
|
||||
- [ ] 提供输入/输出示例
|
||||
- [ ] 量化性能要求
|
||||
- [ ] 定义正确性标准
|
||||
- [ ] 列举边界情况
|
||||
|
||||
### 架构评审任务
|
||||
- [ ] 包含系统图
|
||||
- [ ] 记录组件交互
|
||||
- [ ] 列出当前痛点
|
||||
- [ ] 指定扩展要求
|
||||
- [ ] 记录技术栈
|
||||
|
||||
### 性能优化任务
|
||||
- [ ] 附加分析数据
|
||||
- [ ] 识别瓶颈
|
||||
- [ ] 提供当前指标
|
||||
- [ ] 定义目标指标
|
||||
- [ ] 记录约束
|
||||
|
||||
### 代码审查任务
|
||||
- [ ] 提供完整代码上下文
|
||||
- [ ] 指定审查关注领域
|
||||
- [ ] 识别关键路径
|
||||
- [ ] 列出已知问题
|
||||
- [ ] 定义审查标准
|
||||
|
||||
---
|
||||
|
||||
## MCP 工具检查清单
|
||||
|
||||
- [ ] MCP 服务器运行并可访问
|
||||
- [ ] 所需工具可用（验证 `tools/list`）
|
||||
- [ ] 配置工具权限
|
||||
- [ ] 审查 inputSchema 要求
|
||||
- [ ] 了解工具超时限制
|
||||
- [ ] 准备错误处理策略
|
||||
- [ ] 记录安全约束
|
||||
|
||||
---
|
||||
|
||||
## 发送前验证
|
||||
|
||||
发送前询问自己：
|
||||
|
||||
1. **Codex 能否在不澄清的情况下理解问题？**
|
||||
- [ ] 是 → 继续
|
||||
- [ ] 否 → 添加缺失的上下文
|
||||
|
||||
2. **约束是否完整且具体？**
|
||||
- [ ] 是 → 继续
|
||||
- [ ] 否 → 定义约束
|
||||
|
||||
3. **成功能否客观衡量？**
|
||||
- [ ] 是 → 继续
|
||||
- [ ] 否 → 添加成功标准
|
||||
|
||||
4. **范围对于一次交互是否合理？**
|
||||
- [ ] 是 → 继续
|
||||
- [ ] 否 → 拆分为更小的任务
|
||||
|
||||
5. **是否包含了示例？**
|
||||
- [ ] 是 → 继续
|
||||
- [ ] 否 → 添加示例
|
||||
|
||||
---
|
||||
|
||||
## 快速模板
|
||||
|
||||
### 快速算法请求
|
||||
```markdown
|
||||
**问题**: [一行描述]
|
||||
**输入**: [格式和约束]
|
||||
**输出**: [预期结果]
|
||||
**约束**: 时间: O(?), 空间: O(?)
|
||||
**测试用例**: [一个示例]
|
||||
```
|
||||
|
||||
### 快速性能评审
|
||||
```markdown
|
||||
**函数**: [名称]
|
||||
**当前**: [延迟/吞吐量]
|
||||
**目标**: [目标]
|
||||
**分析**: [热点]
|
||||
**代码**: [实现]
|
||||
```
|
||||
|
||||
### 快速架构问题
|
||||
```markdown
|
||||
**系统**: [描述]
|
||||
**规模**: [当前和目标]
|
||||
**挑战**: [具体问题]
|
||||
**问题**: [集中问题]
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 交接质量评分
|
||||
|
||||
**总评分**: ___/25
|
||||
|
||||
- **20-25**: 优秀 - 准备交接
|
||||
- **15-19**: 良好 - 考虑添加更多细节
|
||||
- **10-14**: 需要改进 - 填补关键空白
|
||||
- **<10**: 未准备 - 缺少主要信息
|
||||
|
||||
---
|
||||
|
||||
返回 [SKILL.md](SKILL.md) 获取主要文档。
|
||||
Reference in New Issue
Block a user