原文鏈接 -> 傳送門
好的文檔是任何項目成功的關鍵。保持文檔可訪問能夠使人們瞭解一個項目；使其易於更新以確保文檔與項目緊密關聯。
記錄項目的兩種常見方法是 README 文件和 wikis：
- README 文件是讓其他用戶瞭解有關你的工作詳情的一種快速簡單的方式。
- GitHub 上的 wikis 幫助你以有用的方式提供關於項目更深層次的信息。
在項目中至少擁有一個 README 文檔是一個好主意，因爲這是許多人第一次發現你的項目時會首先閱讀的內容。
創建你的 README 文檔
當你通過 GitHub 創建一個新的倉庫時，請選擇“Initialize this repository with a README”（除非你計劃導入現有的倉庫）。
您的README.md文件現在可以在您的全新存儲庫中進行編輯。 您的項目名稱在頂部，後面是您在創建存儲庫時選擇包括的任何說明。 README易於修改，無論是在GitHub上還是本地。 查看Mastering Markdown指南，瞭解有關如何修改文件中的文本的更多信息。
現在，可以在你全新的倉庫中編輯 README.md 文件。你的項目名稱位於頂部，隨後是你在創建倉庫時選擇包含的任何說明。無論是在 Github 上還是本地，README 文檔都易於修改。請查看 GitHub（十）：掌握 Markdown 一文，瞭解有關如何修改文件中的文本內容。
格式化你的 README 文檔
README 文檔通常遵循一種格式，以便使開發人員可以立即定位到項目中最重要的部分。
項目名稱：你的項目名稱是人們在滾動 README 文檔時將看到的第一個內容，並且在創建 README 文檔時已經包含在內。
描述：項目的描述在下面。一個好的描述需要是清晰的，簡短的和一針見血的。描述你的項目的重點，以及它的作用。
目錄：（可選的 ->）包含一個目錄可以讓人們在一篇詳細的 README 文檔中快速導航。
安裝：有效的 README 文檔的下一個部分是安裝。它用於告訴其他用戶如何在本地安裝你的項目。（可選的 ->）包含一個 gif 動圖以便別人可以更清楚該過程。
用法：再下一個部分是用法，它用於指導其他用戶在安裝後將如何使用該項目。在這裏，最好包括該項目啓動後的屏幕截圖。
貢獻：對於較大的項目來說，通常會有部分章節是概述如何參與項目的說明。有時，這是一個單獨的文件。如果你有具體的偏好需求，請解釋它們以便其他開發人員指導如何才能最好的參與到你的項目中來。要詳細瞭解如何幫助他人蔘與項目，請查看這篇指南（設置倉庫參與者的指針）-> 傳送門。
名單：包括一個名單的部分，以突出顯示和鏈接到你的項目的作者。
License: Finally, include a section for the license of your project. For more information on choosing a license, check out GitHub’s licensing guide!
許可證：最後，將許可證也一併包含到你的項目中。有關選擇許可證的更多信息，請查看 GitHub 的許可指南 -> 傳送門
你的 README 文檔應該僅包含開發人員開始使用和參與你的項目所需的信息。然而較長的文檔比較適合放在 wikis，如下所述。
創建你的 wiki
GitHub 上的每個倉庫都有一個 wiki。在創建倉庫之後，你可以通過側邊欄導航設置包含的 wiki。啓動 wiki 只需點擊 wiki 按鈕即可創建第一個頁面。
添加內容
wiki 內容被設計爲很容易編輯的形式。你只需要單擊位於頁面右上角的“Edit”按鈕，即可在任何 wiki 頁面上添加或更改內容。這個步驟打開了 wiki 的編輯器。
Wiki 頁面可以用 GitHub Markup 支持的任意格式編寫。使用編輯器中的下拉菜單，你可以選擇 wiki 的格式，然後使用 wiki 工具欄在頁面上創建和輸入內容。wiki 還可以選擇包括自定義頁腳，你可以在其中列出項目的聯繫人詳細信息或許可證信息。
GitHub 跟蹤對你的 wiki 中的每個頁面所做的更改。在網頁標題的下方，你可以看到最近進行過編輯的用戶，還有提交到網頁的次數。點擊此信息將跳轉到歷史記錄的完整頁面，你可以比較修訂內容或查看隨時間變化的詳細列表。
添加頁面
你可以通過點擊右上角的添加新頁面爲你的 wiki 添加頁面。默認情況下，你創建的每個頁面都會自動包含在 wiki 的側邊欄中，並按字母順序列出。
你也可以通過點擊“Add custom sidebar”鏈接將自定義側邊欄添加到 wiki。自定義側邊欄內容可以包括文本，圖像和鏈接。
注意：名稱爲“Home”的頁面是你的 wiki 入口頁面。如果缺少它，將顯示自動生成的目錄代替。
語法高亮
Wiki pages support automatic syntax highlighting of code for a wide range of languages by using the following syntax:
wiki 頁面通過使用以下語法，支持針對各種語言的代碼的自動語法高亮顯示：
\```ruby
def foo
puts 'bar'
end
\```
代碼塊必須以三個反引號（`）開始，（可選的 ->）跟該塊代碼所屬語言的名稱。有關可以語法高亮顯示的語言列表，請參閱 -> 傳送門。
代碼塊內容的縮進與開頭反引號相同的級別。代碼塊必須以三個反引號結束，縮進與開頭反引號相同的級別。
你成功了！
你已經學會了一項新技能，它指導你如何最好地與其餘的 GitHub 社區分享你的工作。無論你的項目是否大到需要擁有自己的 wiki，或者你纔剛剛開始，並建立一個清晰、簡明的 README 文檔。
To read more on the topics covered in this article, our guides for creating a new repository, editing files in your repository, setting guidelines for repository contributors and choosing a license are great places to start. Otherwise, check out some other GitHub Guides to keep learning.
要閱讀更多關於本文所涵蓋的主題，可以參考創建新的倉庫，編輯倉庫中的文件，設置倉庫貢獻者的準則和選擇許可證都是很好的開始。否則，請查看一些其他 GitHub 指南以繼續學習。
Finally, if you’re interested in building a documentation site for your project, we recommend using GitHub Pages.
最後，如果你有興趣爲你的項目構建文檔站點，我們建議使用 GitHub Pages。