技术方案到底怎么写?7步完美搞定!

简介: 总结了作者多年编写技术方案的经验,介绍了如何通过七个步骤来编写技术方案,包括系统用例、功能链路、核心业务流程、数据库设计、接口设计、非功能设计和系统风险点评估,帮助开发人员更高效地进行系统设计和需求分析。

一、背景

工作中,有一些需求或者技术改造,老板总是会要我写出一个技术方案先和他对一对,作为程序员,我相信大家工作中也经常要出技术方案,技术方案有没有一些套路呢,根据多年来的经验,其实是有的,本文就把平时写技术方案的套路总结出来,有需要的同学可以花几分钟时间看下。

二、技术方案重要性

开发人员写代码前,系统设计是不可少的,特别是涉及到新功能或者比较大的系统变更,一般都需要技术方案,技术方案是整个项目相关人员都需要了解的,比如系统关联方,前端测试,产品和其他维护人员,有时候我们的老板也希望能看到我们的技术方案,通过技术方案,更好体现工作量和系统涉及到风险点,还能给项目相关方都看看方案是否合理。还有我们做开发久了会发现,如果一个功能想清楚怎么做了再去落地写代码,写代码的效率会更高。

image.png

本文将结合作者多年工作实际经验和具体案例,对技术方案怎么写来做一次总结,如果你不知道怎么写技术方案,可以先收藏起来备用。大家可以在评论区分享如何写一份比较好的技术方案。

三、常见的技术方案有哪些内容

1、系统用例

这部分能最简单的反映系统的使用者和系统功能的交互,是系统功能的蓝图。

一般会涉及到用户端和管理端的用例,可以通过用例图反映,比如退款申请功能用例:

image.png

2、功能整体链路

这部分是将用例以及各个系统串连起来,有序的完成整个功能的交互,我们可以通过时序图来表示。

通过这部分,可以反映功能涉及到的上下游系统,可以明确到相关接口层面,或者消息等,能体现相关方的工作量风险点。比如下方用户申请退款的时序图简图,作为交易服务,需要依赖支付服务

image.png

2、核心业务流程

这部分相对于第1部分是更细节更详细的设计,是关于业务功能里比较核心的业务逻辑,是一个大功能里对业务起关键作用的流程,比如发起退款里面,对退款的状态变更是比较关键的流程,我们一般要把这种核心功能的流程体现出来,可以用时序图或者流程图,流程图表示可以更直观,对于有一些数据或者状态变更的操作可以给一些推演案例,这点一般测试人员会比较关注。

image.png

下面是退款流水表退款状态的推演记录:

第几次发起退款 发起退款结果 退款状态 退款状态含义
第1次 失败 0 初始化
第2次 成功 1 发起退款中

3、数据库设计

这块内容是对数据库变更的体现,数据库是我们业务系统的最底层,数据库变更应该是需要重视的。我们需要考虑数据库设计的合理性。

是否有新表引入,以及是否有必要性,需要注意新表是否需要分片,考虑数据量增量大小,是否需要定期归档

旧表新字段引入,需要关注新字段是否引入慢查询,是否有大字段,是否有敏感字段,是否需要加索引等,有比较多的情况新功能导致慢sql

我们可以把ddl语句在文档中体现出来,突出是新增还是更新。

退款流水记录表order_refund_record(新增)

CREATE TABLE 'order_refund_record`(
`id`bigint(50) unsigned NOT NULL AUTO INCREMENT COMMENT 'id', order id` varchar (50) NOT NULL COMMENT'订单id',
`refund_status` int(4) NOT NULL COMMENT'退款状态0初始化,1退款中,2退款成功,3退款失败',
'create_time’ datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT'创建时间',
`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT'更新时间’
`is_delete` tinyint(3) unsigned NOT NULL DEFAULT 'O' COMMENT'是否已删除0-未删除1-已删除' 
PRIMARY KEY (`id`),
) ENGINE = InnoDB DEFAULT CHARSET =utf8mb4 COMMENT-'退款流水记录表';

4、接口设计

这部分是比较细节的设计了,一般是用于提供给前端或者上下游系统,通过接口设计可以让相关方了解满足需求。

这部分有rpc接口或者http接口,也可能是消息,需要把传输的数据结构定义明确出来,特别是业务关键字段,让相关方能够评估改动点,可以知道新接口或者新字段是否可以满足需求。工作中常用的接口文档有yapi和swagger。

除了定义接口数据格式,接口设计需要考虑性能,比如幂等设计,是否需要限流

5、非功能设计

5.1、性能与稳定性

非功能设计里面性能和稳定性应该是需要比较看重的,我们做的功能最基础的要保障稳定可用

比如新功能如果有新增配置表,我们可以考虑配置表是否放缓存,避免直接查询数据库,特别是配置表查询qps比较高的情况。

比如依赖多个下游服务,下游服务之间互不依赖,我们可以考虑使用多线程异步并行处理,提高接口吞吐量

5.2、监控

这部分也是很重要的,我们做的功能上线后怎么知道有没正常运行呢?我们除了看数据库,查日志,比较好的方式就是系统自己有业务监控业务打点,通过业务监控可以实时查看业务的实际情况。

比如抽奖活动发奖励的业务功能,我们可以把参与抽奖活动成功,失败,发放各类奖励的数据记录到监控平台,监控平台可视化展示业务监控。

6.3、核对

这是对于一些核心业务功能必须要做的事情,通过核对对账可以确定我们做的功能有没有漏洞,避免公司损失。

核对一般有实时核对离线核对,比如营销活动发优惠券奖励,我们需要核对营销活动发放规则和发放优惠券是否正确,避免出现超发漏发错发的情况。

7、系统风险点评估

这部分我们要思考新功能对系统有哪些风险,比如新功能引入对现有功能的影响点风险点,比如功能流量大对系统稳定性是否有冲击,再比如对依赖服务是否有影响。可能还需要考虑如下点:

数据库是否需要扩容

缓存是否需要扩容

新功能是否需要压测

新接口是否需要限流

四、总结

技术方案应该是相关方共同参与并且需要达成共识,技术方案需要考虑现有的资源成本现有系统影响,以及合理性多方位来分析,通过技术文档可以让相关方理解整个功能的业务流转逻辑,对于后续工作推进也有一定作用。本文结合作者工作中写技术方案的经验做了总结,存在不足欢迎补充或者指正,欢迎大家在评论区分享下自己如何写技术方案。

关注我们一起学习技术吧,坚持相信有输入一定要有输出,希望我们的技术能力越来越强大。

image.png

相关文章
|
项目管理
技术方案怎样写
该文档介绍了编写技术方案的要点和方法。首先强调了技术方案需明确相关方、关键指标、目标受众及预期收益。接着,提到撰写方案时应避免逻辑不清晰、表达复杂和阅读难度高等问题,追求合作共赢、系统规划和显著收益。方案写作框架包括问题、方案、优势和收益。还需深入分析需求,设定SMART目标,关注度量指标如北极星指标,确保方案设计的专业性,合理规划执行路径并做好项目管理,以实现目标并确保团队协作。
543 0
|
存储 数据采集 安全
各种系统架构图与详细说明
原文:各种系统架构图与详细说明 共享平台逻辑架构设计 如上图所示为本次共享资源平台逻辑架构图,上图整体展现说明包括以下几个方面: 1 应用系统建设 本次项目的一项重点就是实现原有应用系统的全面升级以及新的应用系统的开发,从而建立行业的全面的应用系统架构群。
27363 1
|
存储 运维 NoSQL
如何撰写好的技术方案设计-真实案例干货分享
如何撰写好的技术方案设计-真实案例干货分享
2679 0
|
消息中间件 存储 RocketMQ
Rocketmq如何保证消息不丢失
文章分析了RocketMQ如何通过生产者端的同步发送与重试机制、Broker端的持久化存储与消息重试投递策略、以及消费者端的手动提交ack与幂等性处理,来确保消息在整个传输和消费过程中的不丢失。
|
存储 缓存 监控
如何写出一篇好的技术方案?
近期作者在写某个项目的技术方案时,来来回回修改了许多版,很是苦恼。于是,将自己之前写的和别人写的技术方案都翻出来看了几遍,产生了一些思考,分享给大家。
如何写出一篇好的技术方案?
|
开发者
如何画业务架构图
如何快速上手画业务架构图
12418 2
|
JSON 达摩院 Java
大模型时代下的文档智能 | 文档解析(大模型版)
文档智能(Document Mind)是基于阿里巴巴达摩院技术打造的多模态文档识别与理解引擎,提供通用文档智能、行业文档智能和文档自学习能力,满足各类智能文档处理需求。尤其在企业中,它能有效处理文本、图片、扫描件等多种非结构化文档,释放数据价值。本文将介绍文档智能的应用场景、产品架构及其核心功能——文档解析(大模型版),并展示其在线体验与API接口调用方法。
|
项目管理
技术方案撰写之道:实用技巧与方法
本文探讨了如何撰写技术方案,强调了考虑方案的相关方、关键指标、目标受众和预期收益的重要性。文章提出了写作框架应清晰、表达生动、具有美感,并指出好的方案应实现共赢、系统规划和显著效益。写技术方案时,需明确问题、深入分析需求、设定合理目标、设立度量标准、专业设计方案、规划执行路径并有效项目管理,确保方案的成功实施和收益。
1814 0
|
存储 缓存 API
后端的技术方案怎么写?
本文讨论了编写方案的重要性,旨在帮助我们清晰理解需求并确保有效落地。方案应记录实现初衷,方便后续迭代,避免因缺乏文档导致的代码理解困难。通过方案评审,可以考虑通用性和复用性,减少重复工作。文章还强调了在新系统或已有系统上添加功能时需考虑的问题,如系统复杂度、耦合度、API依赖、兼容性、性能和数据处理。此外,方案应涵盖需求背景、系统架构设计(包括业务架构、状态机、存储、服务应用和服务治理)、上线计划和灰度发布策略。最后,文章提到了性能设计、复用性和中台建设的思考,指出设计应以满足实际需求和降低成本为目标。
643 0
|
Cloud Native 架构师 测试技术
如何画好一张架构图?(内含知识图谱)
架构图是什么?为什么要画架构图?如何画好架构图?有哪些方法?本文从架构的定义说起,分享了阿里文娱高级技术专家箫逸关于画架构图多年的经验总结,并对抽象这一概念进行了深入地讨论。内容较长,同学们可收藏起来细细阅读。
15800 0
如何画好一张架构图?(内含知识图谱)