如何写技术方案

2020-11-07  本文已影响0人  花生无翼

前言

对于一般软件开发人员来讲,写代码要比写文字容易得多。很多时候我们都能看到这样的事情,项目做完了,设计文档还没有;
当别人问起,某个项目当时为什么这么设计,一时语塞;项目代码里没有注释,时间长了,自己都忘记当时代码为什么要这么写。
以上这些都是我们平时开发中可能会遇到的问题,为什么会这样?其实就是因为平时没有写文档的习惯,文字没有得以保留,只靠个人记忆,时间长了确实记不住。

写技术方案的好处

既然记不住,那么我们就要写出来,况且写文档的好处是显而易见的。

1.便于讨论

在做技术评审时,只靠讲是不行的,还需要写出来,甚至画出来,这样方便了解和沟通。评审时,别人更容易通过文档指出
技术方案的不足之处,更容易定位到方案技术点。

2.便于分享

好的技术方案是可以借鉴的,优秀的设计方案通过文字保留下来,这样便于分享和传播。

3.便于改进

在做代码review的时候,没有注释的话,别人不知道代码写那么多行是什么意思,这个时候如果有一个文档,文档里面有一个业务流程图的话,
可以更好的帮助大家理解代码的业务逻辑, 从而可以更好的提高review的效率。

如何写技术方案

千万不要觉得写文档麻烦,前期越怕麻烦,往后可能就会遇到更多麻烦。如何输出技术方案?下面一步步梳理下写技术方案的步骤。

1.需求背景

通过阅读需求文档,了解需求背景、产品周期和产品使用人员。

2.业务流程

业务流程最好用图来表示,说的再多可能也不如一张图看的清楚。画好业务流程图,确定项目模块,做好分工。画图工具可以使用visio或者是在线工具ProcessOn。

3.存储系统

软件的核心就是数据存储,找到合适的存储至关重要。那怎么样选择存储结构?除了开发人员自身项目经验外,一种比较好的方法是画图,
这种方法也是最原始的软件设计流程中的一个重要部分。画图可以画流程图、时序图、用例图等,通过看图可以更直接的看出软件每一部分
用到的技术栈,进而选择最合适的存储结构。
选择存储结构的两种方法:
1.画出流程图
最标准的方式也是最有效的方式,通过画出业务流程图,确定每一个模块功能和作用,可以帮助我们选择需要的存储。
是用关系型数据库,还是文件系统,或者是用到NoSQL,这些都是根据具体业务功能来确定的。所以一个描述清晰的业务流程图,

2.做表格
比较存储和存储之间有什么区别,从性能、存储容量、一致性和开发成本等方面做对比,看表格一目了然。结合需求,通过存储的数据
来选择合适的存储结构。

存储系统确定下来后,接下来就是根据业务需求建立表结构,无论是MySQL还是NoSQL都需要有存储结构。

4.接口设计

因为还没开始开发,只是技术评审阶段,写代码之前可以先把接口确定下。在一个项目里,前端和后台用到的接口都罗列出来,
以及涉及到接口参数都写出来。写出来之后,把文档提供给接口使用人,把设计好的接口给对方看下,是否需要增加或者修改。
接口需要双方都明确,一旦明确下来,双方可以同时开发,避免有等待的情况。

总结

做好技术方案的确可以起到事半功倍的效果,确定好技术方案后就可以快速的进入开发流程。开发过程中,如果遇到需求需要调整也可以快速调整。

上一篇下一篇

猜你喜欢

热点阅读