最近的踩坑分享 | 技术文档和需求拆解

简介: 最近的踩坑分享 | 技术文档和需求拆解

技术文档


阅读理解


下图来自某平台的技术对接文档,请重点看一下红线的含义。


刷新token的场景说明:


微信图片_20221112225544.jpg


请大家理解一下,红线处的场景到底想表达什么?

文档中说的在 access_token 过期 1h 之内 是指token过期前1h之内?还是token过期后1h之内?

我们团队同学开始的理解是:token过期后1h之内。

(从正常人的阅读感受来说确实是这样的)


实际情况


但是我在接手这部分逻辑的时候感觉不对。

因为我当时并没有读这个对接文档,而是站在正常刷新token的角度去考虑:

如果让我来设计服务端无感刷新token,我的设计思路是:在token过期前1小时支持通过refresh_token来刷新token。

尤其是当我看到这段之前的代码逻辑时,感觉非常不科学。

(为了方便理解,用伪代码给大家演示)


if 过期时间 > 当前时间 - 1小时 {
   返回cache中的token
}else{
    刷新token的方法
}


比如:过期时间是4点,当前时间是4点半,正常来讲token过期了的;但是按照上面的逻辑:当前时间 - 1小时。4点半就变成了3点半,满足返回cache中token的条件。

显然这种处理方式是不对的,违反常识。


沟通


经过一番沟通确定之后,果然,文档中说的在 access_token 过期 1h 之内是指token过期前1h之内。

哎,这种文档真是坑人啊。


总结


写文档和写注释一定要想清楚,别坑队友。写的模棱两可还不如不写。

对接三方沟通非常重要,当有疑问的时候马上去沟通,不要迟疑。


需求拆解


背景


最近做的工作都没有明确的需求,都是参考之前的代码逻辑,实现新渠道商的对接,导致踩了不少坑。

碰到这种没有明确需求的工作怎么推进呢?


我的踩坑总结


  1. 需求拆解,尽量把需求拆的足够细,以方便评估时间,挖掘出深层次的需求
  2. 明确责任边界,比如碰到和本次需求没有直接关系,但是影响自己开发的bug,一定要及时沟通,尽量让bug的责任人去处理;而不是自己大包大揽都干了。
  3. 及时反馈进度,当做这种需求时,领导大概率也是没想清楚的,所以不知道真正的工作量,更没有一个明确的完成时间的deadline,这种情况下及时沟通进度非常重要。尤其是当意识到可能在规定时间内无法完成,一定要提前告知。
相关文章
|
项目管理
PMBOK泛读(开篇) - 整体思维导图
PMBOK泛读(开篇) - 整体思维导图
54 0
C++编码规范——日积月累、持续更新
C++编码规范——日积月累、持续更新
275 0
|
8月前
|
项目管理
技术方案撰写之道:实用技巧与方法
本文探讨了如何撰写技术方案,强调了考虑方案的相关方、关键指标、目标受众和预期收益的重要性。文章提出了写作框架应清晰、表达生动、具有美感,并指出好的方案应实现共赢、系统规划和显著效益。写技术方案时,需明确问题、深入分析需求、设定合理目标、设立度量标准、专业设计方案、规划执行路径并有效项目管理,确保方案的成功实施和收益。
673 0
|
8月前
|
消息中间件 设计模式 架构师
开发同学的“做事情”&“想事情”&“谈事情”
作为一名后端偏业务向的一线开发,作者抛开技术栈和方案经验等这些具体的内容,从做事情、想事情、谈事情三个方面总结了自己的一些感悟。
|
设计模式 新零售 供应链
一文教会你如何写复杂业务代码
这两天在看零售通商品域的代码。面对零售通如此复杂的业务场景,如何在架构和代码层面进行应对,是一个新课题。针对该命题,我进行了比较细致的思考和研究。结合实际的业务场景,我沉淀了一套“如何写复杂业务代码”的方法论,在此分享给大家。
28679 1
一文教会你如何写复杂业务代码
|
运维 小程序 数据可视化
不用写代码也能开发,产品经理是怎么做到的?
不用写代码也能开发,产品经理是怎么做到的?
100 0
|
存储 Java 程序员
如何写好技术文档——来自Google十多年的文档经验
如何写好技术文档——来自Google十多年的文档经验
587 2
如何写好技术文档——来自Google十多年的文档经验
|
前端开发 jenkins 测试技术
自动化测试技术笔记(一):前期调研怎么做
虽然说自动化测试比较偏技术工作,但在开展前,明确你的工作目标和KPI也是不可忽视的一点。并不是说技术优秀就可以拿到好的绩效,企业生存第一法则是先活下来做产出,再考虑锦上添花和技术优化的事。
|
XML 缓存 JSON
看SpringCloudEureka源码前懂得这些知识事半功倍
看SpringCloudEureka源码前懂得这些知识事半功倍
看SpringCloudEureka源码前懂得这些知识事半功倍
|
SQL Java 程序员
独家下载!《Java开发手册》灵魂13问,深度剖析一线大厂开发思维
《〈Java开发手册(泰山版)〉灵魂13问》独家首发!全网千万阅读量技术博主深度剖析Java规约背后的原理,从“问题重现”到“原理分析”再到“问题解决”,下载《Java开发手册》必备的伴读书目!
249208 2
独家下载!《Java开发手册》灵魂13问,深度剖析一线大厂开发思维