产品工作当中总是经常遇到和外部系统进行系统间对接的场景,看过很多系统交互文档,我的感受是:我们可能看到一份编写优秀的技术类说明文档,却很难看到一份长期保持优秀的文档。
写文章,或者说表达,一直是一种稀缺的能力。
对于技术文章而言,作者要把目标用户时刻放在心里,针对用户的困惑,一步一步的引导进写作者的思路当中。写作者本身逻辑思维不仅要清晰,还要为未来的扩展做好准备。最后还要持之以恒的维护。
然而一份文档由一个人长期维护是很难的,接替者的思路和风格以及能力是否能和前任差不多一定是个小概率事件,接任者能否持之以恒的维护也是问题。
一个优秀的技术类文档编写者,一定是一个优秀的产品,一个跨领域者,既对要描述的内容有比较深刻的理解,也懂得用户角度会遇到什么问题,而提前做好解答。
但现在的环境是什么样子呢?
- 爱谈中国速度,只要快的浮躁的社会
- 工作变动频繁的现状
- 不管是人,还是作品,缺少榜样的力量
- 到处都是凑合就好的草台班子
额外吐槽下读者:
- RTFM
- 整体阅读理解能力严重下降,不管写多清楚都看不懂
- 当读者是甲方的时候,有的甲方那蛮横态度:我就是不读,你想办法让我知道