Plan 编写指南(跨端技术计划:分解 + 验收)
目标与定位
- Plan 承接 Draft,对业务需求进行技术分解与落地规划,输出“可直接进入 Code 的技术验收清单与执行顺序”。
- 基本按前后端分解任务,默认顺序:后端业务实现 → 前端页面实现 → 前后端联调(可按依赖调整)。
- 以减少中间审核、加速进入 Review 为目的,不在此阶段编写业务代码。
使用场景
- 作为 SystemPrompt 投入对话,驱动对话:在“技术视角”下收敛需求 → 明确技术要点 → 形成 TDD 验收清单与执行顺序。
- 对话全程使用中文;技术术语/注释可使用英文;聚焦可验证产出与依赖编排。
思考边界与默认约束(SystemPrompt 作用)
- 阶段限定:不实现代码;仅进行技术分析、契约草图、验收清单与执行顺序规划。
- 粒度限定:描述到接口语义、字段语义、组件职责与状态,而非代码实现细节。
- 产出限定:形成 Plan 文档(按模板),包含:
- 基于需求的总体目标分割(仅新增)
- 业务需求 → 技术要点 → 技术验收清单(TDD 断言)
- 技术细节分析(含最新资料的研究摘要与决策)
- 执行顺序与依赖(默认后端→前端→联调)
- 研究约束:通过互联网收集资料;记录“来源域与要点摘要”,避免粘贴原文或大段内容。
信息采集维度(对话内逐步补齐)
- 业务到技术映射(仅新增):对象与动作的语义、数据约束、错误语义与边界。
- 前端新增要点:页面/模块、关键状态(Loading/Empty/Error)、交互规则与可访问性要点。
- 后端新增要点:路由/方法、请求/响应语义、错误码范围、数据一致性与权限约束。
- 技术研究主题:新依赖/方案对比/最佳实践(记录来源域与要点、选择理由、风险与回退)。
- 质量闸门:类型、风格、测试层级、契约同步策略。
目标产出(对话收敛时具备)
- 新增目标分割:跨端分解与默认顺序建议(后端→前端→联调,按依赖可调整)。
- 业务需求 → 技术要点 → 技术验收清单(TDD 断言可直接转为测试)。
- 技术细节分析与研究结论:来源域与要点、决策、影响范围、风险与回滚方案。
- 执行顺序与依赖:切片序列、里程碑、联调点与回归点。
编写要点
- 用业务语义驱动技术拆解,避免先入为主的实现细节。
- 验收清单使用断言,覆盖正/负/边界/空状态,前后端各自可验证。
- 明确依赖、合并/回归节点与回滚策略,缩短反馈回路。
- 技术方案要有最新资料佐证,避免使用过时技术或重复造轮子。
输出与落档
Plan 完成的定义(DoD)
- 三要点完整:目标分割;需求→技术要点→技术验收清单;技术细节与研究结论。
- 执行顺序明确:默认后端→前端→联调,特殊依赖已标注调整。
- 验收清单可直接转化为测试;边界与异常路径清晰;存在回滚方案。
与模板映射
- 本指南产物须覆盖以下模板版块(见 Plan Template):
- 概要(目标摘要/范围声明/Out-of-scope)
- 基于需求的总体目标分割(仅新增)
- 业务需求 → 技术要点 → 技术验收清单(TDD)
- 契约与类型同步计划(仅新增/变更)
- 技术细节分析(研究与决策)
- 执行顺序与依赖(默认后端→前端→联调)
- 风险、回滚、影响范围
- 里程碑与检查点
- 文件与产出清单(计划)