每當(dāng)接手一個他人開發(fā)好的模塊或者項目，看著那些沒寫注釋的代碼，是不是很抓狂？

每次寫文檔都要花大量的時間處理格式排版等非技術(shù)問題，是不是崩潰？

有時候一份文檔，不止是一個人編寫，幾種不同風(fēng)格摻雜在一起，閱讀起來吃不吃力？

[[312711]]

今天，就和大家分享一個專門為程序員開發(fā)文檔開源管理系統(tǒng)——ShowDoc。

目前，它已經(jīng)在Github上標(biāo)星超5300，1.3K個Fork（Github地址：https://github.com/star7th/showdoc）

它可以用來做什么？

• API文檔（ 查看Demo）

隨著移動互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。

• 數(shù)據(jù)字典（ 查看Demo）

一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個字段的釋義等。

• 說明文檔 （ 查看Demo）

你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊查閱

它都有些什么功能？

• 分享與導(dǎo)出

響應(yīng)式網(wǎng)頁設(shè)計，可將項目文檔分享到電腦或移動設(shè)備查看。同時也可以將項目導(dǎo)出成word文件，以便離線瀏覽。

• 權(quán)限管理

公開項目與私密項目：ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創(chuàng)建者設(shè)置。

項目轉(zhuǎn)讓：項目創(chuàng)建者可以自由地把項目轉(zhuǎn)讓給網(wǎng)站的其他用戶。

項目成員：你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進(jìn)行編輯，但不可轉(zhuǎn)讓或刪除項目（只有項目創(chuàng)建者才有權(quán)限）

團(tuán)隊管理：利用showdoc的團(tuán)隊功能你可以更好地進(jìn)行團(tuán)隊協(xié)作

• 編輯功能

markdown編輯：ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請在搜索引擎搜索”認(rèn)識與入門 Markdown”

模板插入：在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動數(shù)據(jù)了，省去了很多編輯的力氣。

歷史版本：ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復(fù)到之前的版本。

如果你不想安裝，你還可以在線使用ShowDoc。在線地址：https://www.showdoc.cc/

[[312712]]

創(chuàng)建項目也很簡單，你只需要按照步驟一步步創(chuàng)建就可以了：

如果你也對這個項目感興趣，可以下載下來嘗試一下。