plan-work

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Plan work

工作规划

Goal

目标

Produce a plan that is:
  • grounded in repo reality (research)
  • explicit about decisions and risks (analysis)
  • blocked on zero unknowns (Q&A before implementation steps)
生成一份具备以下特点的计划:
  • 基于仓库实际情况(调研)
  • 明确决策与风险(分析)
  • 无未知阻塞问题(实施步骤前完成答疑)

Inputs to ask for (if missing)

需询问的输入信息(若缺失)

  • Outcome/acceptance criteria (what "done" means).
  • Constraints: time, backwards compatibility, performance, security, data migration.
  • Target environment(s): local/stage/prod; any feature flags or rollout requirements.
  • Non-goals (what not to do).
  • 成果/验收标准(“完成”的定义)。
  • 约束条件:时间、向后兼容性、性能、安全性、数据迁移。
  • 目标环境:本地/预发布/生产;是否有功能标志或发布要求。
  • 非目标范围(无需完成的内容)。

Workflow (research -> analysis -> Q&A -> implementation)

工作流程(调研 -> 分析 -> 答疑 -> 实施)

  1. Research (current state)
    • Read repo guidance first:
      AGENTS.md
      ,
      README.md
      ,
      docs/
      (only if needed).
    • Identify entrypoints and owners (backend/frontend/infra).
    • Find relevant code paths and patterns:
      • rg
        for symbols, endpoints, config keys, error strings
      • git log -p
        /
        git blame
        for history and intent when uncertain
    • If the plan depends on external behavior (framework/library/tooling), consult official docs, release notes or context7 (and call out versions/assumptions).
    • Capture findings as short bullets with file paths.
  2. Analysis (what to change and why)
    • Restate requirements and assumptions.
    • List options (1-3) with tradeoffs; pick one and justify.
    • Identify risks/edge cases and what tests cover them.
    • Collect open questions.
  3. Q&A gate (do not skip)
    • If there are open questions, ask them and stop.
    • Do not propose implementation steps until the user answers (or explicitly accepts assumptions).
    • First pass: ask 1-5 questions that eliminate whole branches of work.
    • Do not limit yourself to just 1-5 questions overall; continue asking until everything needed for a proper implementation plan is clarified.
    • Make questions scannable: numbered, short, multiple-choice when possible.
    • Include defaults/recommendations and a fast-path response (e.g., reply "defaults").
      • Do not label any option as the default within the option list; if needed, state defaults in a separate note.
    • Provide a low-friction "not sure" option when helpful.
    • You may add brief bracketed insights after options when there's a major upside or downside.
    • Separate "Need to know" from "Nice to know" when it reduces friction.
    • Structure options for compact replies (e.g., "1b 2a 3c") and restate selections in plain language.
    • Pause before acting until must-have answers arrive:
      • Do not run commands, edit files, or produce a plan that depends on unknowns.
      • Low-risk discovery is allowed if it does not commit to a direction (read-only, non-committing).
    • After answers, restate requirements in 1-3 sentences (constraints + success criteria), then proceed.
  4. Implementation plan (only after Q&A)
    • Break into small steps in a sensible order.
    • Name likely files/dirs to change.
    • Include the tests to run (unit/integration/build) to validate the change.
    • If the change spans modules, include coordination steps (contract changes, client regen, versioning).
  1. 调研(当前状态)
    • 首先阅读仓库指南:
      AGENTS.md
      README.md
      docs/
      (仅在需要时查看)。
    • 确定入口点及负责人(后端/前端/基础设施)。
    • 找到相关代码路径与模式:
      • 使用
        rg
        查找符号、端点、配置键、错误字符串
      • 当不确定时,使用
        git log -p
        /
        git blame
        查看历史与意图
    • 若计划依赖外部行为(框架/库/工具),查阅官方文档、发布说明或context7(并标注版本/假设)。
    • 以带文件路径的简短要点记录调研结果。
  2. 分析(需修改内容及原因)
    • 重述需求与假设。
    • 列出1-3个选项及权衡;选择一个并说明理由。
    • 识别风险/边缘情况,以及覆盖这些情况的测试。
    • 收集待解答的问题。
  3. 答疑环节(不可跳过)
    • 若有待解答问题,先提出问题并暂停。
    • 在用户回答(或明确接受假设)前,不要提出实施步骤。
    • 首轮提问:提出1-5个可排除大量无效工作的问题。
    • 不要局限于仅1-5个问题;持续提问直到获取制定合理实施计划所需的全部信息。
    • 让问题易于扫描:编号、简短,尽可能采用选择题形式。
    • 提供默认/推荐选项及快速回复方式(例如,回复“defaults”)。
      • 不要在选项列表中标记任何选项为默认;若需要,在单独说明中列出默认选项。
      • 必要时提供“不确定”选项。
      • 当选项有重大利弊时,可在选项后添加简短的括号说明。
      • 区分“必须知晓”与“值得知晓”以减少沟通障碍。
      • 结构化选项以便简洁回复(例如:“1b 2a 3c”),并用平实语言重述选择内容。
    • 在获得必要答案前暂停行动:
      • 不要运行命令、编辑文件或制定依赖未知信息的计划。
      • 若不会确定方向,允许进行低风险的探索(只读、不提交)。
    • 获得答案后,用1-3句话重述需求(约束条件 + 成功标准),再继续推进。
  4. 实施计划(仅在答疑后进行)
    • 拆分为多个合理顺序的小步骤。
    • 列出可能需要修改的文件/目录。
    • 包含需运行的测试(单元/集成/构建)以验证变更。
    • 若变更跨模块,包含协调步骤(契约变更、客户端重新生成、版本控制)。

Q&A template (short, feature plan)

答疑模板(简短版,功能计划)

Before I start, I need: (1) question (2) question (3) question. This is a starting set; I will continue with follow-up questions until everything needed for a proper implementation plan is clarified.
Need to know 1) a) b) c) 2) a) b) c) 3) C a) b) c) d)
Nice to know 4) a) b) c)
Reply with: "1a 2b 3c 4a" (or "propose" to have me choose and confirm).
在我开始前,我需要:(1) 问题 (2) 问题 (3) 问题。 这是初始问题集;我会继续提出后续问题,直到获取制定合理实施计划所需的全部信息。
必须知晓 1) a) b) c) 2) a) b) c) 3) a) b) c) d)
值得知晓 4) a) b) c)
回复格式:“1a 2b 3c 4a”(或回复“propose”由我选择并确认)。

Deliverable

交付物

Use
references/plan-template.md
and fill it in.
使用
references/plan-template.md
并填写内容。