怎么才能写好技术文档？这是我的全部经验

文章预览

▲  点击上方“分布式实验室” 关注公众号 回复 “1” 抽取 纸 质 技术书 参加工作时间久一点的工程师应该有这样一个体会：自己平时代码写得再多再好，可一旦要用文档去描述或者表达某一个事情或者问题时，都感觉非常困难，无从下手，不知道自己该写什么不该写什么；或者费了九牛二虎之力写出来的东西没法满足要求，需要再三去修改调整。这其中的主要原因我归纳有两点： 思维方式固化。大部分人平时代码写得太多，文字类型的表述又写得太少。而代码和文字明显是两种不同的思维方式，在代码里陷得太深，不容易跳出来； 本身文字表达能力有限。这个跟写代码一样，有人代码质量高、bug少；有人水平低、bug自然就多。 以上两点其实都可以通过平时多练 ………………………………