3.7 項目的文檔化：README搭建指南

現在，我們已經大致了解了前端項目的一些基礎規范，但是仍然可能錯過一些關鍵的信息。這時，我們就需要通過文檔來深入了解細節。在討論文檔時，有可能說的是需求文檔、設計文檔、測試文檔、用戶手冊等，而這里特指的是與項目相關的技術文檔。

文檔對于一個項目來說，是一個重中之重的存在。當團隊進來一個新人時，需要提供一份快速上手指南；當我們想要了解當前的系統架構時，需要一份能方便查閱的文檔；當我們對過去的技術決策表示懷疑時，需要查看文檔了解原因，并查看架構演進設計。

搭建指南，幾乎是每個代碼庫的必做工作。它最好能以某種形式存在于項目的代碼中，如README，開發人員在復制代碼到本地時，就可以直接查看。并且在項目演進的過程中，持續不斷地對它進行更新，以便其他人能順利地開展活動。

一份好的搭建指南，應該和我們在GitHub上看到的開源項目是相似的，具有如下特點：

◎ 支持運行的環境。

◎ 必要的依賴準備，以及如何搭建。

◎ 項目的安裝指南。

◎ 線上的示例或最后的運行環境。

◎ 相關的文檔鏈接。

◎ 相關人員的聯系方式，討論群。

在大部分項目里，這些必要的資源放在README中，能大大地提高開發人員的效率。