阅读 80

我写技术方案时的思考

这是我参与更文挑战的第18天,活动详情查看: 更文挑战

碎碎言

今日想分享一下作为开发人员应该必备的软技能——文档输出

因业务迭代和需求定制的原因,已经有很长一段时间都在输出了技术方案。整个过程中从讨厌写文档 到现在心里状态虽然没那么厌恶,但还是会有抵触情绪。但,总归还是要去这部分工作,而且其也是技术发展过程必不可少的部分工作。

方案的标准

  • 简洁及可维护性:从工程角度来看,避免难懂的方案。越傻瓜的方案越有生命力。当然简洁的同时也要满足后续扩展的需求
  • 性能、健壮性及可扩展性: 唯快不破,性能是立根之本。我们需要为健壮及性能留有一定扩展余地
  • 避免过度设计:
    • Premature optimization is the root of all evil (过早优化是万恶之源) – Donald Knuth
    • Make appropriate design tradeoff – 老大

实践

核心需求及技术难点:

很多技术方案评审第一段就直奔主题,比如展示模块图或者存储结构,这会让后续读者和听众一头雾水,先告诉阅读对象“我们究竟要解决什么技术问题”是非常关键的

工程目标

有目标才能衡量技术方案能否达到对应程度

图(架构图 or work/data flow):

一图胜千言

详细清晰的文字描述:

方便本地或者文档服务器全文检索,为后来人留下宝贵技术资产

技术指标:

TP95,QPS,TPS等系统核心信息的描述与未来需求扩展支持规划

部署上线方案:

系统上线方案以及灰度、小流量、回滚方案 (如果需要请详细描述)

文章分类
代码人生
文章标签