如何写技术方案

前言

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

写技术方案的好处

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

1.便于讨论

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

2.便于分享

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

3.便于改进

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

如何写技术方案

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

1.需求背景

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

2.业务流程

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

3.存储系统

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

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

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

4.接口设计

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

总结

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

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,919评论 6 502
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,567评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 163,316评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,294评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,318评论 6 390
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,245评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,120评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,964评论 0 275
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,376评论 1 313
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,592评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,764评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,460评论 5 344
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,070评论 3 327
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,697评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,846评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,819评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,665评论 2 354