todo-output-template

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

TODO Output Template

TODO输出模板

This template shows the expected output format for
/todo-task-planning
command results.
本模板展示了
/todo-task-planning
命令结果的预期输出格式。

Overview

概述

The output template demonstrates:
  • Execution Summary: Research performance, technical analysis, and duplicate checks
  • Task Classification: Tasks organized by feasibility (✅ Ready, ⏳ Pending, 🔍 Research, 🚧 Blocked)
  • Complete Checklist Format: All items in markdown checklist format with status indicators
  • Research Rationale: File references (📁) and analysis basis (📊) for each task
  • Git Workflow Integration: Branch creation and PR tasks when
    --branch
    or
    --pr
    options are used
本输出模板展示了以下内容:
  • 执行摘要:研究成果、技术分析和重复检查
  • 任务分类:按可行性组织的任务(✅ 就绪、⏳ 待处理、🔍 待研究、🚧 阻塞)
  • 完整清单格式:所有项均为带有状态标识的Markdown清单格式
  • 研究依据:每个任务的文件引用(📁)和分析基础(📊)
  • Git工作流集成:当使用
    --branch
    --pr
    选项时,会包含分支创建和PR任务

Template Structure

模板结构

Option-Based Variations

基于选项的变体

Differences by Option:
  • --branch
    only
    : Phase 0 (Branch Creation) is added, Phase 4 (PR and Merge) is NOT added
  • --pr
    : Both Phase 0 (Branch Creation) and Phase 4 (PR and Merge) are added
  • No options: Neither Phase 0 nor Phase 4 is added
不同选项的差异
  • --branch
    :添加阶段0(分支创建),不添加阶段4(PR与合并)
  • --pr
    :同时添加阶段0(分支创建)和阶段4(PR与合并)
  • 无选项:既不添加阶段0也不添加阶段4

Full Example Template

完整示例模板

Note: The following is an example when
--branch
option is specified. In practice, include only tasks directly necessary to achieve the objective.
markdown
undefined
注意:以下是指定
--branch
选项时的示例。实际使用中,仅需包含实现目标直接必需的任务。
markdown
undefined

📊 Thorough Execution Summary

📊 详细执行摘要

  • Research Performance: 18 files and 5 directories researched and completed
  • Technical Analysis: Confirmed Nuxt.js 3.x + MySQL configuration
  • New tasks: 6 (✅3, ⏳1, 🔍1, 🚧1)
  • Research Rationale: Detailed analysis of 8 files, confirmation of 3 technical constraints
  • Duplicate Check: Avoided duplication of 4 past researches, 2 questions, 1 task
  • docs/memory saved: analysis/2025-01-15-auth-flow.md, questions/auth-questions.md
  • Updated file: $ARGUMENTS file (directly updated and verified)
  • 研究成果:已完成18个文件和5个目录的研究
  • 技术分析:确认Nuxt.js 3.x + MySQL配置可行
  • 新增任务:6项(✅3、⏳1、🔍1、🚧1)
  • 研究依据:对8个文件的详细分析,确认3项技术约束
  • 重复检查:避免了4项过往研究、2个问题、1项任务的重复
  • 已保存至docs/memory:analysis/2025-01-15-auth-flow.md、questions/auth-questions.md
  • 已更新文件:$ARGUMENTS文件(已直接更新并验证)

📋 Task List (Complete Checklist Format)

📋 任务列表(完整清单格式)

Phase 0: ブランチ作成 ✅ (when --branch option is specified)

阶段0:创建分支 ✅(指定--branch选项时显示)

  • ブランチを作成
    • コマンド:
      git checkout -b feature/actionlog-notification
    • 📋 このブランチで全ての変更をコミット
    • 推定時間: 1分
  • 创建分支
    • 命令:
      git checkout -b feature/actionlog-notification
    • 📋 在此分支中提交所有更改
    • 预估时间:1分钟

🎯 Ready Tasks (✅ Immediately Executable)

🎯 就绪任务(✅ 可立即执行)

  • ✅ API authentication system implementation 📁
    src/api/auth/
    📊Authentication flow confirmed
    • Implement login endpoint - Create
      auth/login.ts
      • 💡 Use Express.js POST handler pattern from
        auth/register.ts
      • 💡 Validate credentials with bcrypt, generate JWT token
      • 💡 Return { token, user } on success, 401 on failure
    • Implement token verification middleware - Create
      middleware/auth.ts
      • 💡 Follow middleware pattern in
        middleware/logger.ts
      • 💡 Use jsonwebtoken.verify() to validate token from Authorization header
      • 💡 Attach decoded user to req.user for downstream handlers
    • Add session management - Extend
      utils/session.ts
      • 💡 Add createSession() and destroySession() methods
      • 💡 Use Redis client pattern from
        utils/cache.ts
  • ✅ Database schema update 📁
    prisma/schema.prisma
    📊MySQL support
    • Update Prisma schema - Add new model definitions
      • 💡 Follow existing User model pattern (id, createdAt, updatedAt fields)
      • 💡 Add Session model with userId foreign key relation
    • Generate migration - Execute
      npx prisma migrate dev
      • 💡 Run after schema changes, provide descriptive migration name
  • [🔄] ✅ User profile page implementation 📁
    pages/user/profile.vue
    - In progress
    • Basic profile display ✓
      components/UserProfile.vue
      completed
    • Add profile edit functionality - Create
      components/UserProfileEdit.vue
      • 💡 Copy form structure from
        components/UserProfile.vue
      • 💡 Add v-model bindings for editable fields (name, email, bio)
      • 💡 Call PATCH /api/user/:id with updated data on submit
  • ✅ Commit after implementation complete
    • 💡 Execute micro-commit to commit changes by context
    • 💡 Estimated time: 2-3 minutes
  • ✅ API认证系统实现 📁
    src/api/auth/
    📊认证流程已确认
    • 实现登录端点 - 创建
      auth/login.ts
      • 💡 参考
        auth/register.ts
        的Express.js POST处理器模式
      • 💡 使用bcrypt验证凭据,生成JWT令牌
      • 💡 成功时返回{ token, user },失败时返回401
    • 实现令牌验证中间件 - 创建
      middleware/auth.ts
      • 💡 遵循
        middleware/logger.ts
        的中间件模式
      • 💡 使用jsonwebtoken.verify()验证Authorization头中的令牌
      • 💡 将解码后的用户信息附加到req.user,供下游处理器使用
    • 添加会话管理 - 扩展
      utils/session.ts
      • 💡 添加createSession()和destroySession()方法
      • 💡 参考
        utils/cache.ts
        的Redis客户端模式
  • ✅ 数据库架构更新 📁
    prisma/schema.prisma
    📊支持MySQL
    • 更新Prisma架构 - 添加新模型定义
      • 💡 遵循现有User模型的模式(id、createdAt、updatedAt字段)
      • 💡 添加带有userId外键关联的Session模型
    • 生成迁移 - 执行
      npx prisma migrate dev
      • 💡 在架构更改后运行,提供描述性的迁移名称
  • [🔄] ✅ 用户资料页面实现 📁
    pages/user/profile.vue
    - 进行中
    • 基础资料展示 ✓
      components/UserProfile.vue
      已完成
    • 添加资料编辑功能 - 创建
      components/UserProfileEdit.vue
      • 💡 复制
        components/UserProfile.vue
        的表单结构
      • 💡 为可编辑字段(姓名、邮箱、简介)添加v-model绑定
      • 💡 提交时调用PATCH /api/user/:id接口发送更新后的数据
  • ✅ 实现完成后提交
    • 💡 按上下文进行微提交
    • 💡 预估时间:2-3分钟

⏳ Pending Tasks (Waiting for Dependencies)

⏳ 待处理任务(等待依赖)

  • ⏳ Frontend UI integration 📁
    components/
    - After API completion (waiting for
    auth/login.ts
    completion)
    • Login form component - Create
      components/LoginForm.vue
    • API client setup - Configure
      composables/useApi.ts
  • ⏳ 前端UI集成 📁
    components/
    - 等待API完成(等待
    auth/login.ts
    完成)
    • 登录表单组件 - 创建
      components/LoginForm.vue
    • API客户端配置 - 配置
      composables/useApi.ts

🔍 Research Tasks (Research Required)

🔍 研究任务(需调研)

  • 🔍 Third-party API integration 📊To research: API documentation and authentication method
    • Review API documentation - Check endpoints and rate limits
    • Determine authentication approach - OAuth vs API key
  • 🔍 第三方API集成 📊待调研:API文档和认证方式
    • 查阅API文档 - 检查端点和速率限制
    • 确定认证方案 - OAuth vs API密钥

🚧 Blocked Tasks (Blocked)

🚧 阻塞任务(已阻塞)

  • 🚧 Payment integration 📊Blocking factor: Payment provider not decided, Stripe vs PayPal
    • Payment provider selection - Compare pricing and features
    • Payment flow design - Determine checkout process
  • 🚧 支付集成 📊阻塞因素:未确定支付服务商,Stripe vs PayPal
    • 选择支付服务商 - 对比定价和功能
    • 设计支付流程 - 确定结账流程

❓ Questions Requiring Confirmation (Checklist Format with Research Rationale)

❓ 需确认的问题(带研究依据的清单格式)

  • [Specification] What authentication method should be used? 📊Current status: Session-based auth implemented, token-based TBD
  • [UI] What is the design system color palette? 📊Current status: Basic Tailwind config, custom theme not set
  • [UX] What are the detailed specifications of the user flow? 📊Current status: Only basic authentication flow implemented
  • [规格] 应使用哪种认证方式? 📊当前状态:已实现基于会话的认证,基于令牌的认证待确定
  • [UI] 设计系统的调色板是什么? 📊当前状态:基础Tailwind配置已完成,自定义主题未设置
  • [UX] 用户流程的详细规格是什么? 📊当前状态:仅实现了基础认证流程

🎯 Next Actions (Checklist Format)

🎯 下一步行动(清单格式)

  • Collect answers to blocker questions, confirm authentication approach
  • Start implementation from ✅Ready tasks, progress step-by-step
  • Confirm and adjust dependencies
undefined
  • 收集阻塞问题的答案,确认认证方案
  • 从✅就绪任务开始,逐步推进实现
  • 确认并调整依赖关系
undefined

Key Elements

关键元素

Status Indicators

状态标识

  • Ready - Immediately executable tasks
  • Pending - Waiting for dependencies
  • 🔍
    Research - Research required before implementation
  • 🚧
    Blocked - Blocked by unclear specifications or decisions
  • [🔄]
    In progress - Currently being worked on
  • [x]
    Completed - Task finished
  • 就绪 - 可立即执行的任务
  • 待处理 - 等待依赖项
  • 🔍
    待研究 - 实现前需调研
  • 🚧
    阻塞 - 因规格不明确或未决策而阻塞
  • [🔄]
    进行中 - 当前正在处理
  • [x]
    已完成 - 任务已结束

Reference Symbols

参考符号

  • 📁
    File reference - Indicates target implementation files
  • 📊
    Research rationale - Shows analysis basis and technical constraints
  • 💡
    Implementation hint - Provides guidance from existing codebase patterns
  • 📋
    Checklist format - Indicates structured task breakdown
  • 📁
    文件引用 - 指向目标实现文件
  • 📊
    研究依据 - 展示分析基础和技术约束
  • 💡
    实现提示 - 提供现有代码库模式的指导
  • 📋
    清单格式 - 表示结构化的任务分解

Task Structure

任务结构

Each task should include:
  1. Status indicator (✅⏳🔍🚧)
  2. Task description with clear objective
  3. File references (📁) showing target files
  4. Research rationale (📊) showing analysis basis
  5. Subtasks with implementation hints (💡) when applicable
  6. Dependencies explicitly stated for ⏳ Pending tasks
  7. Blocking factors explicitly stated for 🚧 Blocked tasks
每个任务应包含:
  1. 状态标识(✅⏳🔍🚧)
  2. 任务描述,目标明确
  3. 文件引用(📁),指向目标文件
  4. 研究依据(📊),展示分析基础
  5. 子任务,必要时附带实现提示(💡)
  6. 依赖项,⏳待处理任务需明确说明
  7. 阻塞因素,🚧阻塞任务需明确说明