程序员和实施如何30分钟写出一篇好文档.docxVIP

#程序员和实施如何30分钟写岀一篇好文档在工作中，文档对我们的重要性不言 而喻。简单的来说，我们写文档的H的有3点：第一，是为了给自己看，工作过 一段时间之后我们自己也会忘记关于当初所编写的代码、所做的实施操作是什么， 那么为了能够让自己的大脑快速恢复场景，有必要将当前发生过的事情用文档的形 式记录一个“快照笃因此我们正确理解文档的作用，首先就是一个快照。第二，是 为了给别人看，无论是项□要码人还是准备要在未来晋升，文档都是可以用来节约 你时间的最好工具，举个例子来说，如果你把刚刚加入项LI组的新人拉到一边不厌 其烦的去讲这个项口的前世今生，不仅你会烦，听的人也会犯困。口述的知识传递 量毕竟有限，如果对方不做笔记，或者讲述者忘记了一些细节，到时候沟通成本将 会成指数级增加。那么一篇好的文档发送给别人，就可以降低你的沟通成本。第 三，是为了技术或者技能提炼或升级。写文档写的多了，便自然会发现相似文档中 的套路，比如实施过程中需要建立表空间，每一次写文档的时候如果都加上了，写 文档的人也会觉得烦，于是便专项提炼岀“如何按标准建立表空间和用户”的文档， 以后再有类似操作，后续的文档完全可以写：“请参见《如何按标准建立表空间和 用户》这就是技能提炼。如果突然有一天发现知识库中有儿百篇实施操作或者 技术文档是讲类似的操作，则可以将这种操作升华为方法论（没有大量实践经验直 接拍脑袋想出来的方法