博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
不会写文档的工程师不是好程序员
阅读量:7260 次
发布时间:2019-06-29

本文共 485 字,大约阅读时间需要 1 分钟。

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


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

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

转载地址:http://poodm.baihongyu.com/

你可能感兴趣的文章
WPF特效-拼图游戏
查看>>
交换机与VLAN:办公室太复杂,我要回学校
查看>>
MVVMLight 实现指定Frame控件的导航
查看>>
WPF 用代码调用dynamic resource动态更改背景 - CSDN博客
查看>>
堆排序
查看>>
unity3dUGUI之UI粒子特效自适应缩放
查看>>
DRDS SQL 审计与分析——全面洞察 SQL 之利器
查看>>
3D卡片折叠动画自定义下拉框
查看>>
你和阿里资深架构师之间,差的不仅仅是年龄(进阶必看)
查看>>
MySQL初始化出错(please install the following Perl modules before executing)
查看>>
Thrift原理分析(二)协议和编解码
查看>>
自己动手开发调试器 01
查看>>
nodejs的事件处理机制以及事件环机制
查看>>
重新上路
查看>>
TeaWeb v0.0.9 发布,统计底层优化、主机监控功能改进
查看>>
在计算机中安装Manjaro
查看>>
mac版QQ聊天信息备份与导出方法
查看>>
硬盘 SMART 检测参数详解[转]
查看>>
linux下svn的常用操作命令总结
查看>>
【网管必备技巧:如何跟踪IP地址】
查看>>