程序员不喜欢写文档,有写文档的时间,还不如把代码再重构一遍。前些年我也这么认为,究其原因,一则自己不喜欢也不擅长写文档,代码是给机器读的,只要语法和逻辑没问题,计算机就能听令运行,而文档是给人看的,除了语法和逻辑,好文档还要照顾读者的心理情绪;二则传统软件的客户对文档无感,它仅仅作为合同约定的交付物而存在,客户压根就不会读这些文档,他们更依赖我们提供的现场培训和技术支持,让客户自己看文档学习太不符合甲方的身份了。
但现如今大部分软件产品都通过互联网向用户提供服务了,在线文档才是最高效的客户服务手段,我们熟知的那些开源软件都配有高质量的帮助文档。好文档已经成为优秀产品的标配,它不仅可以帮你带来更多的用户,而且还可以帮你服务更多的用户。作为互联网程序员的你,要是还不懂写文档,都不好意思跟人打招呼,也别想转型做产品,那如何才能写好产品文档呢?
- 好文档的评判标准是什么
- 文档目录设计与用户思维
- 故事思维让文档不再枯燥
- 故事线模拟用户学习过程
- 进阶式设计跨越学习曲线
- 双视图服务不同类型用户
- 常用开源或免费文档工具
想提升技术写作的能力吗?赶紧订阅吧,本文将带给你技术写作的新思维和新方法!
阅读全文: http://gitbook.cn/gitchat/activity/5b811290a1e80c4a6d958ad7
您还可以下载 CSDN 旗下精品原创内容社区 GitChat App ,阅读更多 GitChat 专享技术内容哦。