不会写文档的工程师不是好程序员

自一年多没做技术以来,遇到一些技术同事离职或者参与平台的架构技术评审,每次都感觉困难,文档是其中一个重要原因,要么是随意写一份交接文档完事,要么就是简单画几副逻辑图来讲解评审,更多的是靠口诉。要说我们团队的这些技术人员个顶个也都算公司中的“高手”,但是我却觉得他们还欠缺一个真正的高手所需要的“一定要让别人清晰的、简单的理解你做的,所说的”。另外我们是如何了解历史的,我想就是因为很多人写下了历史,我们的程序不就是一部历史吗?

当然这篇文章的标题一写出来,估计有很多程序员朋友就要准备喷我了,说“我们高手都是用代码说话”,说“你看王二就是巴结领导写得一手漂亮文档就顺利升迁,技术和shi一样”,说“教条化外包管理才重视文档,俺们崇尚敏捷、极限的开发不重视文档”......我记得咱程序员这个群体有很多标签“木讷、不善言谈、甚至生活邋遢......”,但是从来没有“不善于写”这点,正是由于”善于写“程序员们才有了”不善言谈”的补充,才有了“闷骚”这个标签。


我觉得一份好的技术文档应该.....光说不练大家肯定鄙视我,见两年多前我写的两份技术文档吧。好不好另说,至少态度

不会写文档的工程师不是好程序员_第1张图片

不会写文档的工程师不是好程序员_第2张图片

不会写文档的工程师不是好程序员_第3张图片

不会写文档的工程师不是好程序员_第4张图片


你可能感兴趣的:(文档编写)