如何写好技术设计方案

news/2024/11/13 17:53:54/文章来源:https://www.cnblogs.com/qianqianjuna/p/18544464

重要性

写好技术设计方案,可以提升开发、沟通效率,有利于明确需求、规划架构、识别风险、梳理思路。全盘思考后再去写代码,避免边写代码边思考。

参考目录结构

修订版本

修订版本按时间倒序,用于描述重大修改内容。
参考:

时间 版本号 修改内容 修改人
2024-11-12 V1.1 补充内容 ...... 千千菌
2024-10-10 V1.0 初版 千千菌

1. 设计概要

1.1 背景

业务需求可以直接粘贴PRD上的需求,如果是内生的技术需求,考虑说清楚以下几个问题:

  1. 需求产生的原因(来源)是什么?
  2. 需要主要解决什么问题或场景?有哪些收益?
  3. 需求的变更范围是什么?

1.2 设计范围

功能特性:建议以列表的形式真实,包含功能编号、功能分类、功能描述等信息。

参考:

编号 功能模块 一级功能 二级功能 ...

非功能特性:性能、响应时间、吞吐、安全、隐私、易用性、可测试性

1.3 设计难点

1.4 术语定义

尽量和PRD中的术语保持一致

2. 架构设计/解决方案设计

2.1 整体解决方案

架构 = 模块结构 + 运行机制

  1. 明确目标(一个系统?服务?接口?)
  2. 针对目标进行结构拆解(系统 -> 服务、服务 -> 接口、接口 -> 实现类)
  3. 将拆解后的接口进行关联描述(连线?分层?聚合?)

2.2 架构和关系图

对于架构图的补充和细化,对不同的场景,可以选择不同类型的 UML 图来说明:模块关系图、时序图、ER图、领域模型、系统层次图、部署结构图

2.3 系统触发条件

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.hqwc.cn/news/833049.html

如若内容造成侵权/违法违规/事实不符,请联系编程知识网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

GIS工具哪家强?五款优质GIS工具箱对比分析

本文将为大家介绍五款功能各异的GIS工具箱,包括GISBox、QGIS、MapTiler、Saga GIS和Whitebox GAT。每款工具箱都有其独特的功能和应用场景,能够满足不同类型的GIS任务需求。无论是数据处理、空间分析、影像处理还是可视化需求,这些工具都能为用户提供丰富的解决方案。本文将…

安装Kibana__基于Windows系统

在此之前,请先安装Elasticsearch并启动一、下载安装包并解压安装https://www.elastic.co/downloads/kibanaterminal进入Kibana安装目录,通过.\bin\kibana.bat指令启动 二、配置后登录Kibana页面 启动成功,访问http://localhost:5601/,页面会要求你填入EnrollmentToken(此…

【Maya 2025软件下载与安装教程 含补丁】

1、安装包 「maya2025」: 链接:https://pan.quark.cn/s/de0d9d452470 提取码:Rhjp 「maya2024」: 链接:https://pan.quark.cn/s/887e52b68f51 提取码:jvyp 「maya2023」: 链接:https://pan.quark.cn/s/71f46b3d26e5 提取码:b6mA 「maya2020」: 链接:https://pan.qua…

Prometheus + Grafana 监控平台搭建

1、下载 prometheus和node_exporter:https://prometheus.io/download/ 下载完后上传到服务器解压 tar -zxvf prometheus-3.0.0-rc.1.linux-amd64.tar.gztar -zxvf node_exporter-1.8.2.linux-amd64.tar.gz2、启动 node_exporter nohup ./node_exporter --web.listen-address…

阿里云可观测 2024 年 10 月产品动态

阿里云可观测 2024 年 10 月产品动态

题解:CF2025E Card Game

在这 权当卡特兰数的复习题吧。不会卡特兰数的可以先看文末。如果没有花色 \(1\) 这道题就很简单了,对于每个别的花色都有 \(C(m)\) 种分配方案。\(C(n)\) 表示卡特兰数的第 \(n\) 项,答案就是乘起来。 发现除了花色 \(1\) 每种花色的牌都是独立的。这启示我们枚举每种牌用了…

应用网关的演进历程和分类

网关作为互联网流量的入口,其形态也在跟随软件架构持续演进迭代中。我们下面就聊一聊网关的演进历程以及在时下火热的 AI 浪潮下,网关又会迸发怎样新的形态。作者:耿蕾蕾(如葑) 唯一不变的是变化,在现代复杂的商业环境中,企业的业务形态与规模往往处于不断变化和扩大之中…

Vue网站发布到iis后提示404页面不可访问

vue重定向和跨域配置:https://zhuanlan.zhihu.com/p/5306882511.安装组件:URL Rewrite:https://www.iis.net/downloads/microsoft/url-rewriteApplication Request Routing:https://www.iis.net/downloads/microsoft/application-request-routing2.新建一个web.config 放到…

fastadmin 数据记录行上添加操作按钮并设置权限

1. 一键 curd 以及配置菜单 编写控制器方法 - 业务逻辑 再次一键生成菜单 - 生成刚刚写审核通过方法的控制器。 2. 自定义控制器中方法。 3. 查看角色组的权限,并授予该角色权限。 4. 前端修改 index 页面,因为需要权限所以需要加上一句话data-operate-log="{:$auth-&g…

10 倍性能提升, GraalVM 应用可观测实践

ARMS 发布了支持 GraalVM 应用的 Java Agent 探针,可为 GraalVM 应用提供开箱即用的可观测能力。作者:铖朴、层风 GraalVM 静态编译 背景介绍 随着云原生浪潮的蓬勃发展,利用云原生技术为企业应用提供极致的弹性能力是企业数字化升级的核心诉求。但 Java 作为一种解释执行+运…

日立移动硬盘插在电脑有异响数据恢复

当日立移动硬盘插在电脑上出现异响且数据无法读取时,这通常表明硬盘可能遇到了某些问题。以下是一些建议的解决步骤和数据恢复方法: 一、异响原因排查 供电不足: 移动硬盘需要足够的电力供应才能正常工作。如果电脑的USB接口供电不足,可能会导致移动硬盘发出异响且无法读取…

辣椒销售策略:智慧应对顾客,洞悉销售真谛

售卖辣椒的商贩常常面临这样的询问:“你的辣椒辣不辣?”回答这个问题时,他们面临两难:若答辣,怕辣之人即刻离去;若答不辣,或许又错失了喜辣的顾客,交易依旧难以达成。 某日闲暇,我驻足于一位售卖辣椒的妇人三轮车旁,好奇她如何解决这一逻辑悖论。 见暂无顾客,我自以…