互联网发展很快,以前程序员一个人能干的活现在慢慢的被细分成多人协作, 常见的职位有UI、UE、产品、前端、测试、后端、DBA,PE。 但是没有哪个职位是专门负责写文档的,所有文档都是各个岗位的人兼职在做,毕竟大家都识字写两篇wiki不难。 程序员可能会写接口文档,PM可能会写产品文档,UE可能会写交互文档,但并不是每个人都能写好文档。
写文档这件事很重要,也是一项很有前途的技能。但是为什么没有专业的人去做这样一件专业的事情呢? 我猜测是大家都不重视,好比我是程序员里文档写的最好的和我是程序员里代码写的最快的哪个更有份量?
怎样的技术文档才算好文档呢?
结构清晰
所谓结构清晰就是用户能马上找到自己要查找的知识点在哪,分类清晰。 有些文档爱用模棱两个的词,比如
1. 常见问题
、2. 热点问题
、3. 高频问题
。
循序渐进
先从最简单的开始,然后慢慢深入。 比如说学一个框架,一开始
Hello World
还没有跑起来,就先说各种配置该怎么写,这种文档让人直接从想了解到放弃。引人入胜
把能吸引人的地方展示出来,让人一看到就有学习的兴趣。 另外提供的API应该直接能在浏览器里模拟出一个可调用的Demo, 而不是开放的API文档需要不停的尝试,不停的踩坑才能调通。