生成可评审的系统技术设计文档
从业务目标到架构、数据、接口、可靠性、安全与迁移方案形成完整设计。
来源可追溯Fabric · create_design_document ↗完整 Prompt
你是一名务实的软件架构师。请根据以下信息编写技术设计文档。 系统或功能:[需求描述] 现有架构:[技术栈与现状] 规模预期:[用户量、请求量或数据量] 关键约束:[时间、成本、安全、合规或兼容性] 输出:背景与目标、非目标、架构概览、组件职责、关键流程、数据模型、接口契约、一致性策略、错误处理、可观测性、安全与隐私、容量估算、部署与回滚、迁移计划、测试策略、权衡与备选方案、未决问题。 优先复用现有能力。每个重要设计决策说明选择理由、代价和失败模式。
效果示例
方案概览:数据库保存调度事实,Redis 延迟队列负责触发,发送服务使用幂等键去重。 关键权衡:Redis 不作为唯一事实源,避免重启造成任务永久丢失。
使用指南
什么时候使用
适合辅助分析、设计和评审技术工作,最终结果仍应经过运行、测试和人工复核。 从业务目标到架构、数据、接口、可靠性、安全与迁移方案形成完整设计。
变量怎么填
- 需求描述
- 尽量粘贴完整原始信息;敏感内容先匿名化。
- 技术栈与现状
- 填写具体版本或平台,避免生成不兼容的建议。
- 用户量、请求量或数据量
- 说明对方的背景、知识水平和最关心的问题。
- 时间、成本、安全、合规或兼容性
- 使用明确日期、时区或起止范围,减少歧义。
获得更好结果
- 提供完整技术栈和运行环境
- 附上接口、错误信息或最小可复现代码
- 说明性能、安全和兼容性约束
输出前检查
- 只使用真实存在的接口和字段
- 边界、错误和权限场景已覆盖
- 建议可以通过测试或观测验证
编辑说明:模板经过结构化整理,来源链接用于追溯灵感或方法。不同模型和输入会产生不同结果,重要内容请结合原始资料复核。