對于一般的程序員來說，花費數小時來創建代碼或修改現有代碼只是一天工作中的一部分，簡而言之，當程序員忙于他們最新的項目時，他們會把自己與外界隔絕，這種刻板印象還是有一定道理的。

但是你沒發現的是其實很多程序員還需要是保存關于他們的代碼如何工作的文檔，事實上，很多程序員都不愿意寫文檔，編程心理學的作者和專家Gerald Weinberg將其總結為“編程的蓖麻油”——換句話說，這是一件對他們有好處但他們討厭做的事情。

如果沒有一個好的文檔，關于軟件如何運行的信息就會缺乏，現如今，許多開發者最多就是在他們編寫的代碼中留下一個基本的路線圖，但這依然不能解決代碼的終端用戶的問題，因此，軟件開發人員必須養成良好的文檔記錄習慣，這樣你的黑盒代碼才不會對其他人來說是一個謎。

今天，和大家推薦4個不錯的在線軟件文檔工具：

1. GitHub Pages

現在大多程序員都會使用通用代碼庫Github，所以對于希望保存文檔的程序員來說，Github是一個不錯的選擇，盡管很多人只是利用代碼庫中的readme功能來為項目提供簡單的操作指南，但這并非是最好的辦法。

GitHub pages，它的項目頁面(包括文檔和手冊)提供了一個專用的托管平臺。它直接與所有GitHub存儲庫交互，允許開發人員以更新代碼的方式更新文檔。最關鍵的是，用戶可以使用Jekyll，將純文本標記轉換成成熟的靜態網站，而不需要額外的編程。

地址：https://pages.github.com/

2. Read the Docs

顧名思義，Read the Docs為開發人員提供了一個集中的平臺來保存文檔，這樣用戶就可以直接閱讀文檔了。它的工作原理有點類似GitHub pages，因為開發人員可以從他們喜歡的版本控制系統(包括Git、Bazaar、Mercurial等)中推送文檔更新。

不過，Read the Docs最好的部分還是它的靈活性，因此開發人員可以自動化大部分的文檔創建過程，這樣一來就可以節省大量的時間，最重要的是，平臺上的所有內容都以多種格式向公眾開放，形式包括pdf、HTML，電子閱讀等。

地址：https://readthedocs.org/

3. Tettra

雖然不是嚴格地作為軟件文檔平臺，但是作為一個成熟的知識庫，Tettra仍然是一個非常好的軟件文檔工具。當一個項目設計到多個程序員，而非技術用戶想要了解整個項目細節的時候，Tettra最為適用。對于大多數軟件開發人員來說，Tettra在記錄與他們工作相關的常見問題的答案時表現最為突出。

地址：https://tettra.com/

4. Apiary

盡管軟件文檔始終被認為是關鍵任務，但是有一種類型的文檔是任何開發人員都不能忽視的——API文檔，由于它們是軟件中最容易被外部用戶發現的部分，所以當某些事情不清楚時，它們也會產生很多的問題。Apiary是一個平臺，允許用戶使用Markdown編寫其文檔，包括模擬API調用。此外，該平臺允許用戶測試API，換句話說，它既是一個文檔工具也是一個測試平臺。

地址：https://apiary.io/