技术人如何写出一篇好的技术方案(技术人如何写出一篇好的技术方案)

花匠人从多个角度为你分享技术人如何写出一篇好的技术方案(技术人如何写出一篇好的技术方案),让你更加了解技术人如何写出一篇好的技术方案(技术人如何写出一篇好的技术方案),包含农业百科相关的养殖方法和注意事项、病虫害防治、形状特征、文化等农业百科知识。

  本篇文章为你整理了关于技术人如何写出一篇好的技术方案(技术人如何写出一篇好的技术方案)的详细内容,包含有技术人如何写出一篇好的技术方案 技术人如何写出一篇好的技术方案范文 怎么写好技术方案 怎样写技术方案,希望能帮助你了解技术人如何写出一篇好的技术方案。

  产品:验证技术方案是否能够 match 上产品方案测试:验证技术方案对测试方案是否有足够 & 准确的输入同事 & leader:参与技术方案评审,验证技术方案的合理性新人(不单单指新同学也指新接触这一块的同学):拿到技术方案可以很快对某一块的事情熟悉起来

   我们都知道技术方案是指导具体开发工作的,可以分别从开发的事前、事中、事后来讨论这个问题。

   事前

  明确的目标:整个技术方案要达成什么目的低沟通成本:产品测试能从技术方案上获取足够的输入,不需要反复找你确认技术选型思考:为什么要这么做?和业内方案相比有什么好处和坏处,如何权衡的

   事中

  少调整:尽可能少的技术方案需要调整, 否则无法完成开发任务

   事后

  少补丁:尽可能少的 bug 或者遗漏可扩展 & 可复用:相对简单的改动就能支持新增需求,类似场景可复用不需要重复开发

   一篇好的技术方案可以贯穿整个研发的生命周期,并且能起到很好的指导意义,就如同写小说之前作者必须出一个大纲的逻辑是一致的。

  

如何写一篇好的技术方案

 

   清晰的目标

   1. 产品类需求——业务方 or 产品方发起提给技术,包括但不限于以下几种:

  页面交互:能提升多少的运营操作效率,多少 PV、UV 这种可量化的数字?业务 SOP 调整:带来的业务价值是什么?是能降多少本还是提升多少时效?数据订正:订正能解决什么问题?防止多少钱未结算?又或者是防止多少客诉?

   2. 技术类需求——技术自发提出,包括但不限于以下几种:

  性能优化:优化多少?20%、30% 还是 50%?数据隔离:隔离的范围是什么,涉及多少张表,多少数据?可以减少当前的什么问题?减少多少?各种小工具:没有小工具之前是什么样?有之后是什么样?可以带来什么好处?研发效能提升:提升多少?有没有可以量化的指标?而不是为了做而做。

   大纲图

  图不用很细(比如加工比较复杂我们可以简单写**加工),但是要能看到全貌,具体的每个模块如果需要展开的,那么在对应的详细设计中体现即可,在这里我们关注的是整体;接口如有归属不同的应用要标明;数据存储介质不同要标明;数据流转的箭头要清晰明确;数据加工计算的输入和输出要体现,同时要体现加工的运行环境(比如到底是 odps 计算还是内存计算,内存计算的话是在那个应用)。

   大纲图的逻辑示意参考

   模型设计

   讲到数据模型设计,E-R 图是必不可少的,E-R 图应该包含以下信息:

   1. 每个领域对象,如果要持久化,都有表来存储。我们设计完 ER 图的时候,应该根据这条原则做一番检查,避免漏掉一些表。在大型项目中,漏掉表是很常见的事情,应尽量避免。

   2. 领域对象之间的关系,如果要持久化,都要在表结构中体现。这种体现,可能是 code 字段,可能是外键,可能是中间表。我们设计完 ER 图的时候,也应该根据这条原则做一番检查,避免漏掉一些关系。在大型项目中,漏掉关系更是司空见惯,应尽量避免。

   3. 清晰定义的表名。设计 ER 图的时候,就要设计出清晰定义的表名。清晰定义的表名,可以帮助大家理解 ER 图,可以帮助大家映射回领域对象及其关系。在后续的设计和实施中,将沿用这个表名。

   4. 清晰定义的字段名、字段类型、字段长度和枚举值。很多同学容易忽略这点,他们往往清晰定义了表名,却没有重视表的字段。认真去做的时候,会发现,这里面有很多工作。例如,字段名是否合适,用什么类型好,字段长度多少合适,是否有枚举值等等,都需要一一斟酌。如果这点做好了,在实施的时候,可以避免很多麻烦,甚至避免返工。

   对外依赖提前确认

   技术方案 1:需要依赖缓存、分布式调度中间件、消费外部的消息,但是没有把对应的中间件使用方式、数据格式贴出来。

  外部 hsf 依赖:需要确认对应 hsf 接口的类、方法、version,以及二方包(也可使用泛化调用);外部消息依赖:需要确认消息的 topic、数据格式;分布式调度、缓存等中间件:当前应用是否接入过该中间件,未接入需要去到官网确认接入文档,接入的话需要确认是否可以复用接入逻辑。

   内部前后模块依赖 & 层次结构

   模块依赖层次从高到低分为:

  领域依赖(如交易依赖商品)应用依赖(如 cntcp 应用依赖 cngfc 应用)接口依赖(如滚存看板查询接口依赖于锁接口 & 渠道集接口)

   我们举接口依赖的例子来看:一共三个接口分别是滚存看板查询接口、锁接口、渠道集接口,滚存看板查询接口依赖于锁接口和渠道集接口。

   技术方案 1 目录层次:滚存看板查询接口、锁接口、渠道集接口;

   技术方案 2 目录层次:锁接口、渠道集接口、滚存看板查询接口。

   很明显,技术方案 2 是更加合理的,A 依赖于 B 那么 B 应该先做。我们在写技术方案的时候,要考虑什么应该在前什么应该在后,而不是想一步写一步。要有一个清晰、有序的结构,不然别人看起来就会是杂乱无章的。

   一个模块里面应该有啥

   下面列出一个技术方案的模块里面应该要写哪些东西,供参考:

   1. 具体的接口定义

   要求:实现一个飞机运力合同查询接口,入参为运力大区

  入参:

   {"area":"南美"}出参:{"date":"***"}技术方案2:

  方法名:CapacityService.queryPlan

   入参:

   {"cnArea":"南美"}出参:{"date":"***"}这里总结对接口定义有几点要求:

  完整的类和方法名入参字段如果系统中已有,那便沿用;如果没有,那么英文的描述需要准确(可同产品业务商榷)出参字段要求同入参

   2. 详细的时序图

   要求:实现一个学生信息查询接口。技术方案 1:写出查询结果中执行的相关步骤。

  step1. 入参校验

   step2. 查询A表

   step3. 对A标返回结果做校验

   step4. 查询B表

   ······技术方案 2:在 1 的基础上使用时序图表达出来。

   推荐使用技术方案 2,好处是尽管内容相同但是时序图能够更直观地看到层次、数据流转等信息。除了以上比较基础的 2 点,我觉得的还有一些要点:

  数据加工的详细图(如有)——同样推荐用图的形式可以更直观消息设计(如有),明确消息生产方、消费方、tps、数据结构自测用例(推荐),比较重要的功能点构造一些自测用例

   ······

   技术选型分析

   要求:实现一个定时任务,定期将过期的数据删除。

   技术方案 1:使用 spring 自带的定时器进行数据清除。

   安全生产

   安全生产包括几个部分,包括且不限于下面几个部分

  监控对账灰度方案数据隔离兼容性评估发布流程

   我们举一个例子。

   需求:在消费者收货成功时触发对商家的结算。

   技术方案 1:******,写了一堆如何触发结算、如何更好地支持后续的可扩展性;

   监控:

  监控目标:写清楚监控的是什么内容监控点:如通过打印日志监控,那么日志打印在哪个类的哪个方法监控触发:是通过 sunfire 采集触发还是其它,如果是 sunfire 采集最好能把监控项地址贴出来监控订阅人:监控告警需要的订阅人监控触发后的解决方法:如果发生异常该如何解决?如手工触发结算

   对账:

  对账目标:写清楚对账是为什么对账方式:写清楚是怎么对账的(如通过 odps 天级定时任务,履行单上的关务资源 code 和日志表中关务 cp 回传报文的关务资源 code 对比要一致,不一致的形成某个数据集,通过锦衣卫-资损风险平台配置)对账告警订阅人对账异常之后的解决办法

   还有其它几个部分也补充说一下:

   灰度方案,包括但不限于:

  多方前置准备灰度切流开关设计灰度切流节奏异常应对

   向前兼容性,包括但不限于:

  接口的向前兼容:尤其是对外的接口数据结构的向前兼容:如不能随意改变字段的存储类型和格式

   环境隔离:

  如有租户隔离 & 预发线上隔离的情况需要考虑数据

   发布流程,包括但不限于:

  发布计划检查项列表发布流量监控

  

最后

 

   啰啰嗦嗦写了一些东西,以上内容只是个人的一些想法,欢迎各位同学分享和交流自己的见解。

   参考文章

   1.《技术方案设计的方法论及案例分享》,作者不拔,来自ATA

   2.《详细技术方案的要求》,作者骥禹,来自ATA

以上就是花匠人为你整理的技术人如何写出一篇好的技术方案(技术人如何写出一篇好的技术方案),如果你还想了解更多农业百科知识,请持续关注花匠人。

郑重声明:本文版权归原作者所有,转载文章仅为传播更多信息之目的,如作者信息标记有误,请第一时间联系我们修改或删除,多谢。

留言与评论(共有 条评论)
   
验证码: