ShowDoc是一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔、技術(shù)文檔工具。通過(guò)showdoc，你可以方便地使用markdown語(yǔ)法來(lái)書(shū)寫(xiě)出美觀的API文檔、數(shù)據(jù)字典文檔、技術(shù)文檔、在線excel文檔等等。如果不想編輯markdown文檔，你還可以利用showdoc的自動(dòng)化能力，從程序注釋中自動(dòng)生成API文檔，或者從搭配的RunApi客戶端(類似postman的api調(diào)試工具)中一邊調(diào)試接口、一邊自動(dòng)生成文檔。通過(guò)分配項(xiàng)目成員和團(tuán)隊(duì)成員，你可以很方便地進(jìn)行項(xiàng)目文檔的權(quán)限管理和團(tuán)隊(duì)協(xié)作，也可以分享文檔出去給朋友查看。ShowDoc還支持多平臺(tái)客戶端，有win客戶端、mac客戶端、ios、android等，更方便跨平臺(tái)使用。目前超過(guò)100000+的互聯(lián)網(wǎng)團(tuán)隊(duì)正在使用showdoc，包括知名公司內(nèi)部的一些團(tuán)隊(duì)，比如騰訊、華為、百度、京東、字節(jié)跳動(dòng)、順豐等等。

它可以用來(lái)做什么

1、API文檔

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

2、數(shù)據(jù)字典

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

3、說(shuō)明文檔

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

它都有些什么功能

1、分享與導(dǎo)出

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

2、權(quán)限管理

（1）、公開(kāi)項(xiàng)目與私密項(xiàng)目

ShowDoc上的項(xiàng)目有公開(kāi)項(xiàng)目和私密項(xiàng)目?jī)煞N。公開(kāi)項(xiàng)目可供任何登錄與非登錄的用戶訪問(wèn)，而私密項(xiàng)目則需要輸入密碼驗(yàn)證訪問(wèn)。密碼由項(xiàng)目創(chuàng)建者設(shè)置。

（2）、項(xiàng)目轉(zhuǎn)讓

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

（3）、項(xiàng)目成員

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

（4）、團(tuán)隊(duì)管理

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

3、編輯功能

（1）、markdown編輯

ShowDoc采用markdown編輯器，無(wú)論是編輯還是閱讀體驗(yàn)都極佳很棒。如果你不了解Markdown，請(qǐng)?jiān)谒阉饕嫠阉?rdquo;認(rèn)識(shí)與入門(mén) Markdown”

（2）、模板插入

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

（3）、歷史版本

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

4、多平臺(tái)

showdoc支持網(wǎng)頁(yè)版、手機(jī)app版和電腦客戶端版。

5、自動(dòng)化

（1）、可從代碼注釋中自動(dòng)生成文檔

（2）、搭配的RunApi客戶端，可調(diào)試接口和自動(dòng)生成文檔

更新日志

修復(fù)了一些安全問(wèn)題