首页 程序人生 程序员如何讲清楚技术方案

程序员如何讲清楚技术方案

最近在评审技术方案,和代码review的时候,遇到刚入行的同学们,很多都讲不清楚技术方案。

具体表现是:

  • 上来不说需求,直接说算法实现。台下一头雾水,根本不知道设计方案是否合理。
  • 描述完需求后,又直接看代码,看表结构,没有交代流程。
  • 比较简单的算法,描述的特别绕,让人听不懂。被别人指出后,觉得这东西这么简单,你们为什么听不懂,还很委屈。
  • 直接说术语,不给解释。还有自己造术语不给解释的,更混乱的是「复用」已有的术语,让大家理解都不同。

那么程序员如何把技术方案讲清楚呢?下面从实用的角度教大家一些小技巧,在短时间内具备讲清楚的能力。在文末给出通用的方法论学习书籍,供长线学习,达到把所有事情都能交代清楚。

一、要先交代需求背景

为什么要做这个需求,对于实现的要求是什么,产品经理提了哪些边界条件。没有银弹,一个技术方案的好坏与实现要求息息相关,是不能脱钩的。例如,一个接口访问质量统计系统,可以接受一天跑一次脚本生成数据。但是为用户提供服务的消费明细,肯定要能实时展示,并且不能出错。

在评审中,消耗时间比较多的,就是台下的听众问被评审人需求背景。还有台下的人给出了某个建议,然后被被评审人否定,说有个产品的要求我刚才没说。这时对提出建议的人来说,是很伤的。

交代好背景并对齐,是评审技术方案和代码review的基础,否则别人不知道你后面的是否合理,甚至不知道你到底在做什么。技术方案评审就无从谈起了。

二、介绍技术方案整体架构

背景知识说完后,说你的做法。要先总后分,先从整体介绍架构设计。有哪些模块,各自负责什么职责,如何衔接……让大家有个整体认识,看到哪部分是主要矛盾,大家把80%的精力花费在20%的重要模块上评审,好钢用在刀刃上。

例如一个发奖活动,最重要的模块是发奖抽奖模块,但是上来不讲整体,而是先讲展示活动规则的模块,而且用掉了大半的时间,是很浪费人力的。

整体架构的描述用架构图、流程图,加上简练的语言,交代明白即可。一般都有架构模板,直接按照模板的要求,参考已有的优秀例子,都不会有大问题。最重要的是这块要先讲,先交代清楚。

三、介绍协议、库表设计

整体方案介绍完之后,介绍协议和数据库表设计,开始逐步深入细节。因为这块设计的是否合理,对程序的效率影响比较大。

分清哪些协议、表是重要的,着重讲,其他不太重要的快速讲。

协议的执行流程,要交代清晰,整个协议是怎么在各个模块中流转的,到具体数据修改时,是如何和已有表结构串联起来的。这也是程序执行的流程,如果讲不清楚,会深度怀疑你是否能实现清楚。

这部分要注意,尽量少说术语。因为大家的背景知识不同,一些专门术语大家是不知道的,你要用直白的话语让大家听明白。

例如:有人在描述协议流程时说「我调用server提供的123号命令,返回成功后,把数据库的state字段改为2,就完成发奖了」。但是你说的123是干什么的,state是什么意思,2是什么状态?

大家的疑问太多了,好的说法应该是,「我调用server提供的123号发奖的协议,返回成功后,把数据库中该用户的发奖状态,更新为已发奖」。

四、描述分支和异常逻辑,讲解代码

经过前面几部的讲解,方案基本上讲完了。剩下的就是讲分支逻辑,和异常逻辑。一份代码写的好不好,程序员是否有经验,主要是看对于异常处理是否到位。

这部分从架构上主要讲容灾、鲁棒性,例如某个server死掉了,或者某个模块频繁请求,你的系统是否有预警,能够兼容。说白了就是要讲解系统的边界条件和服务能力。

最后上代码,如果是代码review,在这个时候才开始说你的代码。虽然看的时间比较晚,但是大家都知道你的代码是什么功能了,看的速度也会加快。

五、复盘

每次评审后,要自己复盘,总结。别人都问题哪些问题,为什么要问?哪些问题是我应该交代没交代的,让人家问了?哪些是我方案的问题,别人提出的挑战?

对于自己没交代的,思考为什么会漏,如果能提前讲清楚,是否能节约很多时间。

根本的心法就是要有同理心。从对方的角度思考,这个问题他会了解吗,我不说他明白吗?方案评审重要的不是你说完,而是别人听懂。关注台下人的反应,你的任务不是讲,而是让大家听明白。不是一个劲的说,而是要让大家都理解你的意思,这样别人才能帮你。否则别人会一直问问题,挑战你,最后否定你的方案。

千万不要觉得听众好笨,这么简单都不明白,如果台下的人都不明白,那么一定是你错了。能力强的人是能够把难题讲解的很简单的。美国有专门负责科普的作家,把复杂的科学知识做到「老妪能解」。台下评审的人都是身经百战的,如果他们都反映听不懂,那么会是谁的问题呢?

总结

技术方案讲解要先交代背景,再讲整体架构,再细化流程。先主线,再分支,先正确路径,再异常逻辑。要在听众的角度去讲,尽量直白简单,能够让不懂技术的人听懂才是最好的。


延伸阅读
通用的方法论可以学习《金字塔原理》《问题的分析与解决》中的SCQA、MECE等方法,这些才是根本,要努力学习和刻意练习才能够掌握。

站心网

最近在评审技术方案,和代码review的时候,遇到刚入行的同学们,很多都讲不清楚技术方案。具体表现是:上来..

为您推荐

程序员职业发展与技能要求

程序员是从事计算机程序开发、维护和优化的专业人员。他们通过编写代码,设计软件系统,解决技术问题,推动技术创新。以下是程序员的一些关键信息:核心技能编程语言:掌握如Python、Java、C++、JavaScript等语言。..

程序员离职时删除代码注释算违法吗?

程序员离职前删除代码注释是否违法,取决于多个因素,包括雇佣合同、公司规定、法律条款以及删除行为的动机。以下是几个关键分析点:1. 合同与公司规定劳动合同或保密协议:如果合同或公司规定明确要求代码的完整性..

创造型职业程序员的无奈

编程是为数不多的一种既能满足个人爱好,又能赚钱的职业之一。烹饪是另一个这样的例子。在一般情况下,大多数职业要么不可能让你待在家里(例如医生和电工),要么你没有兴趣在家里做(例如清洁)。同样的,大多数好..

程序员副业探索之电商

目录一、小程序化妆品1.1 小程序准备(营业执照&微信支付&小程序appId)1.2 小程序开发二、拼多多电商三、跨境电商四、总结在腾讯广告工作期间,我主要负责小程序电商与广告业务,见证了互联网电商行业的剧变,特别..

谈程序员如何做好业务

前言技术能做两种事情,通过技术实现业务和通过技术支持技术。我们大部分时候做的是前者,养活我们的大部分也是业务。 近两个月,作为项目负责人角色从0到1经历了新项目的几个版本迭代,跨入了部分新领域,也有一定..

程序员增加收入的几种方法

在这个互联网飞速发展的社会,学会如何make money很重要。咱们是个俗人,赚钱才是社会生存的头等大事。这不是高山流水的世界,而是能力创造财富,对于程序员来说,更是如此。作为程序员,我们有更多挣钱的姿势,注意..

程序员跳槽到对手公司,被前老板设计陷害

这件事发生在2007年,我就职的第一家公司。今天把它整理写出来,希望它对程序员有一个警醒的作用。永远要记住,程序员的世界除了有代码,还有被套路。资深工程师的苦恼第一天到公司,是浩子带着我办理了入职手续。浩..

程序员如何提一个好问题

提出好的问题是在编写软件时的一个非常重要的技能。这么多年来我对此也算略有小成。这里有一些我用着觉得很棒的指导方针!开始我实际上是那种总是会问出愚蠢问题或“不好”问题的大信徒。我一直在问人们一些愚蠢并且..

我是李玉宝,我是个程序员!

听说今天我的名字很火,那我也来凑个热闹。在2015年的时候,我做过一次人生总结,当时写了:为了理想,我放弃了一切! 转眼到了2019年,说说最近一年多的一些事情吧!做的好的!坚持把权限管理框架OpenAuth.Net做了..

程序员失业日记1:工作五年,交接半天

最近发现越来越多的小伙伴被公司裁员,有的是因为公司业绩不景气被裁员,有的是因为压力太大离职。很多公司都在裁人、减员。找工作也比之前难。刚好去年我也被上家裁员了,正好做一个系列的日志,希望能帮到在找工作..

天天写业务代码,如何成为技术大牛?

不管是开发、测试、运维,每个技术人员心理多多少少都有一个成为技术大牛的梦,毕竟"梦想总是要有的,万一实现了呢"!正是对技术梦的追求,促使我们不断地努力和提升自己。然而"梦想是美好的,现实却是残酷的",很多..

改善程序员生活质量的 3+10 习惯

一封离职邮件2017年的一天,代码伴随着手指极具节奏感地输出在IDE上,突然某Chrome插件弹出一封邮件提示:“今天是我在ThoughtWorks的最后一天”。遇到这种离职邮件,我都会点进去,一来看看是否是自己曾经共事的小..

倾听程序员的心声真的很重要

说到开发产品,没有人比程序员更了解产品。程序员知道产品的优点、缺陷、用途和潜在用途。说起这些,程序员了如指掌,如数家珍。在这个似乎无所不在的数字时代,倾听程序员必须要说的内容非常重要,而且也许比以往任..

助力程序员成功的几个好习惯

老实说,如果你google搜索“程序员的好习惯”这方面的内容,那么就会有很多大同小异的文章映入你的眼帘。但是今天我想从一个略有不同的角度来探讨这个主题。不是关于如何更擅长编程,而是如何使程序员更有市场竞争力..

倔强的程序员

对于程序员来说,大多数人公司都有技术和管理两条发展路线,通常在同一家公司,管理路线的发展可能性,要相对广阔一些;但是技术路线也有技术路线的好处,比如相对而言更依赖于硬实力,因而工作机会丰富。我相信有不..

程序员如何在当今就业市场中让自己脱颖而出

俗话说,钱不是万能的,但没有钱是万万不能的。可见钱对于生活的重要性。不管你从事什么职业,实现财务自由才能让你无所畏惧地应对挑战。但是还有一点是值得开发人员所关注的:如何脱颖而出与众不同。毫无疑问,软件..

领域驱动设计,让程序员心中有码(七)

-设计原则和设计模式,互联网开发者们共同的追求 前言多年来,笔者一直从事传统软件企业的软件开发和项目管理工作。笔者发现在众多的传统软件企业中,评判优秀开发者的标准往往是技能的熟练程度,基本上都是以梭代码..

如何成为一名成功的程序员

编程是一个仅靠兴趣仍不足以抵达成功彼岸的领域。你必须充满激情,并且持之以恒地不断汲取更多有关编程的知识。只是对编程感兴趣还不足以功成名就——众所周知,我们工作起来像疯子。编程是一个没有极限的职业,所以..

写作路上的这些小成绩,铸就了一个不平庸的程序员

01 好的写作平台可以加速我们的成长“路漫漫其修远兮,吾将上下而求索”,在写作这条漫漫长路上,我已经求索了将近5年的时间;在这5年时间里,有过兴奋,有过迷茫,但幸好,我未曾放弃。2014年的4月初,我在ITeye(..

如何学习新技术

我总是感觉自己在盲目的学习一些看上去很火热的技术。比如 React Native,Flutter 等等。我家里堆了各种编程语言的入门书籍,有 Go 的,有 Erlang 的,有 c++ 的,还有 JavaScript 和 CSS。我到现在都搞不懂这个事情..

发表回复

返回顶部