今天是贝贝报告给你的第 84 天 
2019-05-23 星期四 

为什么我要在项目还没做完的时候，就搭建文档？简单说，因为天时、地利与人和。

第一是天时——建文档，这是最好的时候。有些项目没有彻底完结的时候，所以不能等。有些项目拖的时间比较长，后期已经记不清前面怎么做、怎么想的了。一开始就搭建，既保证随时都有现成的文档，又保证了及时记录，也给后期编辑留出了时间。

第二是地利——搭出框架，才知道写什么，往哪放。有些事情不做不知道门道，写文档就是这样。当你思考文档架构的时候，才会去想应该做什么。当把手放在键盘上的时候，才会去想心里的意思到底是什么。

第三是人和——早写文档有利于合作。这种合作不只在操作层面上，还在心理层面上。有了文档，公开出来，就是给人读的（哪怕数据显示没人点开看）。心中读者的存在，屏幕背后的那双眼睛，会很大程度地影响选词和行文，让这些东西更有利于将来的合作。

做事的，测试的，封装的，写文档的，都是一个人。既然如此，为什么不一开始就搭建文档呢？

阅读原文，指向挂在 Github Pages 上的项目文档。 ​