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

它可以用來做什么

1、API文檔

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

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

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

3、說明文檔

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

它都有些什么功能

1、分享與導出

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

2、權(quán)限管理

（1）、公開項目與私密項目

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

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

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

（3）、項目成員

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

（4）、團隊管理

利用showdoc的團隊功能你可以更好地進行團隊協(xié)作

3、編輯功能

（1）、markdown編輯

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

（2）、模板插入

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

（3）、歷史版本

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

4、多平臺

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

5、自動化

（1）、可從代碼注釋中自動生成文檔

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

更新日志

修復了一些安全問題