對于一般的程序員來說，花費(fèi)數(shù)小時(shí)來創(chuàng)建代碼或修改現(xiàn)有代碼只是一天工作中的一部分，簡而言之，當(dāng)程序員忙于他們最新的項(xiàng)目時(shí)，他們會(huì)把自己與外界隔絕，這種刻板印象還是有一定道理的。

專注于為中小企業(yè)提供網(wǎng)站設(shè)計(jì)制作、成都網(wǎng)站建設(shè)服務(wù),電腦端+手機(jī)端+微信端的三站合一,更高效的管理,為中小企業(yè)上海免費(fèi)做網(wǎng)站提供優(yōu)質(zhì)的服務(wù)。我們立足成都，凝聚了一批互聯(lián)網(wǎng)行業(yè)人才，有力地推動(dòng)了上千家企業(yè)的穩(wěn)健成長，幫助中小企業(yè)通過網(wǎng)站建設(shè)實(shí)現(xiàn)規(guī)模擴(kuò)充和轉(zhuǎn)變。

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

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

今天，和大家推薦4個(gè)不錯(cuò)的在線軟件文檔工具：

1. GitHub Pages

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

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

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

2. Read the Docs

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

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

地址：https://readthedocs.org/

3. Tettra

雖然不是嚴(yán)格地作為軟件文檔平臺，但是作為一個(gè)成熟的知識庫，Tettra仍然是一個(gè)非常好的軟件文檔工具。當(dāng)一個(gè)項(xiàng)目設(shè)計(jì)到多個(gè)程序員，而非技術(shù)用戶想要了解整個(gè)項(xiàng)目細(xì)節(jié)的時(shí)候，Tettra最為適用。對于大多數(shù)軟件開發(fā)人員來說，Tettra在記錄與他們工作相關(guān)的常見問題的答案時(shí)表現(xiàn)最為突出。

地址：https://tettra.com/

4. Apiary

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

地址：https://apiary.io/

本文題目：程序員都討厭寫文檔？這4個(gè)工具讓你事半功倍
地址分享：http://uogjgqi.cn/article/dhjeshc.html