关于技术文档的思考

这几天有了一个新的任务,写一份技术文档。这份技术文档和以往的都不太一样,为什么这么说呢,因为它不是接口文档、业务规则、交接文档,也不是设计说明书,更不是需求文档、用户说明书……而是一个关于项目用到的各种比较潮流的技术的文档。这个文档里要求写6种技术,主要是分布式、微服务、人工智能(预测)、大数据、数据采集收集整合、统计分析、esb、BI、组件化可配置。要求页数在Word的40-50页。主要的侧重点在技术的特性、应用、和在当前业务中的使用。

当然列举技术的特性和使用方法,就可以完成这个文档的大部分。但我在写的过程中,却有了新的感觉。其实如果严格的要求,对自己高标准的话,这个文档应该是根据我们的系统,写出技术营销帖的效果。以我们的系统为基础,去阐述这项技术的特性的体现。比如分布式和微服务,以我们的系统为基础,阐述从单机到集群。从刚开始设计架构的考量,去支持微服务,到后来随着业务的扩展,将系统升级支持微服务。并且阐述以此带来的优点。

感觉就像是在各大公众号上看到的热门帖子和技术分析贴一样,有系统的介绍推广,也有贴切实际的技术的阐述,更有新颖的观点和亮点体现。

目前要写出这样的文档,毫无疑问,对我来说还是很有难度的。肚子里没这方面的积累,此时也倒不出来。

作为一个技术管理人员,要写这样的文章下笔如有神,基础是日常对技术的优缺、特性、发展趋势敏感,各大技术分析帖,毫无疑问要如数家珍,每项技术提起来都要可以聊几句,言之有物。当这些娴熟之后,看到新技术也很积极的了解,养成一种在技术前沿的习惯,可能就可以设计出来自己的系统和体系结构,而写这样的文章,也就不是问题了。

希望这一天早点到来。

原文地址:https://www.cnblogs.com/mySummer/p/14778569.html