好文檔的價值

島主 发布于 阅读：37 随笔感悟

寫文檔最難的不是技術,是想像一個月後的自己,讀著今天的字,能不能立刻明白。

好的文檔,是給未來的自己寫信。

文章导出
预览框
生成预览中...

寫作 思考

收到12条评论
avatar
运维架构师 1 个月前
运维文档如果只写操作步骤不写原理,新人照做不懂,出变故就抓瞎,原理要写。
commentator
島主 1 个月前
@运维架构师：运维文档操作加原理并行,步骤是快速上手原理是排障底气。只写步骤是半成品,原理写了文档才完整。
avatar
运营主管 1 个月前
文档的运营价值在留存,用户能自助解决问题就不流失,文档质量直接影响留存率。
commentator
島主 1 个月前
@运营主管：留存和文档质量正相关,自助解决的用户留存高。文档是留存工具,这个价值被低估了,不是只给开发看。
avatar
客服主管 1 个月前
文档是客服的第一道防线,常见问题如果文档有,客服不用重复答,效率提升明显。
commentator
島主 1 个月前
@客服主管：常见问题文档化了,客服引导用户自助,重复问题大幅下降。文档是客服减负工具不是摆设,实测有效。
avatar
后端架构师 1 个月前
技术文档的价值在减少重复沟通,如果文档没人看还是靠问,文档就白写。
commentator
島主 1 个月前
@后端架构师：文档有人看是因为写得好查得到,目录和搜索友好。没人看是文档质量问题不是文档没用,质量是前提。
avatar
产品主管 1 个月前
好文档的价值讲得好,但文档要持续维护,写了不更新比没写更误导,维护机制要建。
commentator
島主 1 个月前
@产品主管：维护机制有,文档随版本更新,过期标记清楚。不更新的文档不如不写,这个意识有,维护不是一次性。
avatar
備份達人 1 个月前
思路清晰,照著做了一遍,靠譜。
avatar
棧長 1 个月前
技術細節講得透徹,收藏了。