3.7 项目的文档化：README搭建指南

现在，我们已经大致了解了前端项目的一些基础规范，但是仍然可能错过一些关键的信息。这时，我们就需要通过文档来深入了解细节。在讨论文档时，有可能说的是需求文档、设计文档、测试文档、用户手册等，而这里特指的是与项目相关的技术文档。

文档对于一个项目来说，是一个重中之重的存在。当团队进来一个新人时，需要提供一份快速上手指南；当我们想要了解当前的系统架构时，需要一份能方便查阅的文档；当我们对过去的技术决策表示怀疑时，需要查看文档了解原因，并查看架构演进设计。

搭建指南，几乎是每个代码库的必做工作。它最好能以某种形式存在于项目的代码中，如README，开发人员在复制代码到本地时，就可以直接查看。并且在项目演进的过程中，持续不断地对它进行更新，以便其他人能顺利地开展活动。

一份好的搭建指南，应该和我们在GitHub上看到的开源项目是相似的，具有如下特点：

◎ 支持运行的环境。

◎ 必要的依赖准备，以及如何搭建。

◎ 项目的安装指南。

◎ 线上的示例或最后的运行环境。

◎ 相关的文档链接。

◎ 相关人员的联系方式，讨论群。

在大部分项目里，这些必要的资源放在README中，能大大地提高开发人员的效率。