showdoc電腦端是一款功能強(qiáng)大且專業(yè)的API文檔編輯工具，軟件采用Markdown編輯器，用戶可以通過它快速編寫出美觀的API文檔，支持從代碼自動(dòng)生成API，每個(gè)程序員都應(yīng)該有寫文檔的習(xí)慣，不管是后期處理bug還是團(tuán)隊(duì)之間的協(xié)作都會(huì)更有效率。這款showdoc就是一個(gè)非常適合IT團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率。感興趣的朋友快來下載使用吧。

showdoc for mac (API文檔編輯工具)  蘋果電腦版

軟件功能

1、編輯功能

（1）markdown編輯

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

（2）模板插入

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

（3）歷史版本

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

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

3、權(quán)限管理

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

ShowDoc上的項(xiàng)目有公開項(xiàng)目和私密項(xiàng)目?jī)煞N。公開項(xiàng)目可供任何登錄與非登錄的用戶訪問，而私密項(xiàng)目則需要輸入密碼驗(yà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ì)管理

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

軟件用途

1、API文檔

隨著移動(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文檔

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

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

3、說明文檔

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

ShowDoc是什么

每當(dāng)接手一個(gè)他人的模塊或者項(xiàng)目，看著那些沒有解釋說明的資料，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ?。?/p>

技術(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ì)之間溝通的效率。

更新日志

Showdoc v2.4.0更新日志：

1、界面簡(jiǎn)潔友好

2、性能體驗(yàn)優(yōu)化提升

3、修復(fù)了已知bug