2.5 KiB
2.5 KiB
Design 模板
设计信息
- 设计名称: [设计名称]
- 设计类型: [界面设计 | 架构设计 | 数据结构设计 | 流程设计 | 其他]
- 设计日期: YYYY-MM-DD
- 设计版本: vX.X.X
- 设计作者: [作者姓名]
输入引用
引用相关的 docs 文档链接:
Context Maps
强制列出本次设计依赖的 Canvas 文件:
- Authentication.canvas - 项目架构视觉化展示
- 相关节点: 节点名称 - 描述
设计目标
明确描述此设计的目标和预期效果,包括要解决的问题、实现的功能或达成的结果。
设计内容
概述
简要描述设计的整体思路和架构。
详细设计
1. [设计模块 1]
- 设计说明: 详细说明设计模块的功能和实现方式
- 设计图: [设计图名称] - 描述
- 关键元素: 列出设计中的关键元素
- 实现细节: 说明实现的具体细节
2. [设计模块 2]
- 设计说明: 详细说明设计模块的功能和实现方式
- 设计图: [设计图名称] - 描述
- 关键元素: 列出设计中的关键元素
- 实现细节: 说明实现的具体细节
设计关系
描述各个设计模块之间的关系和交互方式。
约束
列出设计时的约束条件,例如:
- 技术栈限制
- 性能要求
- 安全性要求
- 兼容性要求
- 其他约束
Rule Set
"请严格参考 @Authentication.canvas 中的状态机转移逻辑,不要自行发挥。"
具体规则:
- 必须使用 Canvas 中定义的类名和方法名
- 必须遵循 Canvas 中定义的调用关系
- 必须参考 Canvas 中的流程图逻辑
验收标准
定义验证设计质量的具体标准,例如:
- 功能完整性
- 设计合理性
- 实现可行性
- 性能指标
- 用户体验
风险
识别设计可能带来的风险,例如:
- 技术实现风险
- 性能风险
- 兼容性风险
- 维护风险
- 其他潜在风险
设计变更记录
| 日期 | 变更内容 | 变更原因 | 变更人 | 审核人 |
|---|---|---|---|---|
| YYYY-MM-DD | 变更描述 | 变更原因 | 变更人姓名 | 审核人姓名 |
使用指南
适用场景
描述设计适用的场景和条件。
实施步骤
提供设计实施的具体步骤。
维护建议
提供设计维护的建议和注意事项。