ShowDoc(API文檔,技術(shù)文檔工具)

ShowDoc是一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔、技術(shù)文檔工具，一款優(yōu)秀的API文檔編寫工具，可以幫助廣大開發(fā)者和用戶快速編寫出集美觀和實(shí)用為一體的API文檔，支持團(tuán)隊(duì)合作和任務(wù)分配等等功能，操作十分簡(jiǎn)單，有需要搭配朋友歡迎體驗(yàn)。

ShowDoc是什么：

每當(dāng)接手一個(gè)他人開發(fā)好的模塊或者項(xiàng)目，看著那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ��！

程序員都很希望別人能寫技術(shù)文檔，而自己卻很不希望要寫文檔。因?yàn)閷懳臋n需要花大量的時(shí)間去處理格式排版，想著新建的word文檔放在哪個(gè)目錄等各種非技術(shù)細(xì)節(jié)。

word文檔零零散散地放在團(tuán)隊(duì)不同人那里，需要文檔的人基本靠吼，吼一聲然后上qq或者郵箱接收對(duì)方丟過來的文檔。這種溝通方式當(dāng)然可以，只是效率不高。

ShowDoc就是一個(gè)非常適合IT團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率。

它可以用來做什么：

API文檔（ 查看Demo）

隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁(yè)前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔，同時(shí)還將支持從代碼文件中自動(dòng)生成API文檔

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

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

說明文檔（查看Demo ）

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

它都有些什么功能：

分享與導(dǎo)出

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

權(quán)限管理

公開項(xiàng)目與私密項(xiàng)目

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

項(xiàng)目轉(zhuǎn)讓

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

項(xiàng)目成員

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

團(tuán)隊(duì)管理

你可以自行添加多個(gè)團(tuán)隊(duì)，為團(tuán)隊(duì)分配不同的項(xiàng)目，同時(shí)設(shè)置團(tuán)隊(duì)里每個(gè)人的權(quán)限。

編輯功能

markdown編輯

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

模板插入

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

歷史版本

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

使用說明：

安裝到自己的服務(wù)器

安裝手冊(cè)：https://www.showdoc.cc/help?page_id=13732

開源地址：https://github.com/star7th/showdoc

使用在線的ShowDoc

如果你沒有自己的服務(wù)器，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc http://www.showdoc.cc

http://www.showdoc.cc 作為在線服務(wù)會(huì)長(zhǎng)期維護(hù)，請(qǐng)放心托管你的文檔數(shù)據(jù)。使用在線服務(wù)時(shí)請(qǐng)記住showdoc唯一官方網(wǎng)址https://www.showdoc.cc

ShowDoc交流群

ShowDoc使用交流qq群

交流群①：564671853（已滿）

交流群②：174709989（已滿）

交流群③：667194478

如果你覺得ShowDoc好用，可以轉(zhuǎn)發(fā)此文到你的技術(shù)社區(qū)以支持ShowDoc。感謝支持。