跳到主要内容

Draft 编写指南(Story 根文档:需求确认 + 简易原型)

目标与定位​

  • Draft 是单个 Story 的根文档,面向“需求确认与简易原型确认”。
  • 目标:限定思考边界、以精炼对话指引快速对齐业务语义与可视化原型,减少中间审核成本,为后续 Plan 直接产出 TDD 验收清单创造条件,尽快进入 Review。

与流程的关系(总览)​

  • Draft → Plan → Code → Iteration → Review
  • 一份 Draft 对应一个 Story;Draft 可被分解为多个 Plan。
  • 每个 Plan 对应一次完整的 Code(TDD:Structure→Mock→Test→Realize)与随后一次 Iteration(测试与小步迭代)。
  • 所有 Plan 的产物合并为 Story 的完整实现,进入 Review(人工验收与最终确认)。

使用场景​

  • 作为 SystemPrompt 投入对话,驱动多轮澄清与原型确认。
  • 目标是在尽量少的往返中,拿到足以进入 Plan/Code 的“精炼且完整”的 Draft。
  • 对话全程使用中文;如需技术术语/注释,可在必要处使用英文。

思考边界与默认约束(SystemPrompt 作用)​

  • 阶段限定:仅做需求澄清与原型确认;不落入代码级实现与技术细节决策(放到 Plan/Code)。
  • 产出限定:本阶段产出 Draft 文档(按模板)与单文件 HTML 原型草案;如用户明确不需要,可仅输出文档。
  • 方式限定:逐步对话采集信息,不要求一次性给齐;对未知项给出“最小可行假设 + 需确认清单”。
  • 语言规范:对话与文案中文优先;如需关键术语或注释,使用英文;业务描述避免技术术语主导。
  • 质量取向:必须覆盖正/负/边界/空状态;明确 Out-of-scope;对外部依赖给出可验证假设。

信息采集维度(对话内逐步补齐)​

  • 标题与一句话价值陈述(用于聚焦价值目标)
  • 角色与用户故事(含正/逆向路径)
  • 端到端用户流程(入口 → 关键交互 → 状态变化 → 结果),标注 Loading/Empty/Error
  • 业务规则与边界:输入约束、前置条件、异常与回退路径、Out-of-scope
  • 验收标准(业务语义,非技术实现):覆盖正/负/边界/空状态;后续由 Plan 转化为 TDD 断言
  • 非功能性主题(性能/安全/可用性/可访问性等,按需)
  • 风险/依赖与开放问题(技术/业务不确定性、外部系统、数据约束等)
  • 简易原型:默认需要单页 HTML(或原型截图/草图);若暂无法落地,以文字先行并约定最小可行原型

目标产出(对话收敛时具备)​

  • Draft 文档:覆盖“信息采集维度”的关键要素
  • 简易原型(单页 HTML 或截图/草图),用于确认关键界面、交互热区与主要状态
  • 业务语义化的验收标准清单(后续 Plan 将其转化为 TDD 断言)
  • 基本 Plan 安排(默认顺序):后端业务实现 → 前端页面实现 → 前后端联调;具体依赖可在 Plan 阶段细化与调整

简易原型制作与验证​

  • 制作要点
    • 借助 Chrome MCP 了解当前系统已经实现的页面和功能,并基于当前实现完成新的原型。
    • 以关键页面/弹窗/表单为单位,体现核心信息层级与主要交互热区
    • 使用静态占位与最小交互(按钮/输入/导航模拟),不强求真实数据
    • 显式呈现 Loading/Empty/Error 等主要状态(骨架/占位文案即可)
    • 文案中文为主,便于快速对齐

编写要点​

  • 用业务语言澄清“做什么/为什么/如何验证”,避免落入实现细节
  • 统一领域术语与对象语义,减少后续歧义
  • 正/负/边界/空状态必须覆盖;明确 Out-of-scope
  • 对外部依赖或不确定性给出可验证的假设,便于 Plan 接力

输出与落档​

  • 对话收敛后,按 Draft Template 输出完整 Draft 文档(Markdown)。
  • 默认生成单文件 HTML 原型;先征求路径/命名确认再落档(如用户明确无需,可跳过)。

Draft 完成的定义(DoD)​

  • “信息采集维度”覆盖关键项、无关键冲突
  • 简易原型可用于可见性与可操作性确认
  • 业务验收标准可被 Plan 直接转化为 TDD 断言
  • 风险/依赖/开放问题明确,具备可跟进的澄清路径

与模板映射​

  • 本指南驱动的对话产物须完整覆盖以下模板版块(见 Draft Template):
    1. 用户角度的需求分析要点
    2. 系统应实现的功能核心列表(含边界)
    3. 可视界面的核心要素(UI/UX 与交互)
    4. 整体实现方案与执行顺序(Plan 概览)
    5. 文件与产出清单(HTML 设计稿与 Plan 文件名建议)

注意事项​

DO's ✅​

  • 面向用户价值与可验证性,高效补齐“信息采集维度”(不强求一次性提供)
  • 用简易原型提高对齐速度,避免在文字上反复
  • 明确边界与异常路径,减少后续返工

DON'Ts ❌​

  • 不在 Draft 中写实现或技术细节(留给 Plan/Code)
  • 不遗漏负向/边界/空状态
  • 不将原型做成高保真或强绑定现有样式框架