ShowDoc是什么
每當(dāng)接手一個(gè)他人開(kāi)發(fā)好的模塊或者項(xiàng)目客扎，看著那些沒(méi)有寫(xiě)注釋的代碼祟峦，我們都無(wú)比抓狂。文檔呢徙鱼？宅楞！文檔呢？袱吆！Show me the doc Ｑ嵫谩！
程序員都很希望別人能寫(xiě)技術(shù)文檔绞绒，而自己卻很不希望要寫(xiě)文檔婶希。因?yàn)閷?xiě)文檔需要花大量的時(shí)間去處理格式排版，想著新建的word文檔放在哪個(gè)目錄等各種非技術(shù)細(xì)節(jié)蓬衡。
word文檔零零散散地放在團(tuán)隊(duì)不同人那里喻杈，需要文檔的人基本靠吼彤枢，吼一聲然后上qq或者郵箱接收對(duì)方丟過(guò)來(lái)的文檔。這種溝通方式當(dāng)然可以筒饰，只是效率不高缴啡。
ShowDoc就是一個(gè)非常適合IT團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率龄砰。
它可以用來(lái)做什么
-
API文檔（ 查看Demo）
隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展盟猖，BaaS（后端即服務(wù)）越來(lái)越流行。服務(wù)端提供API换棚，APP端或者網(wǎng)頁(yè)前端便可方便調(diào)用數(shù)據(jù)式镐。用ShowDoc可以非常方便快速地編寫(xiě)出美觀的API文檔。
-
數(shù)據(jù)字典（ 查看Demo）
一份好的數(shù)據(jù)字典可以很方便地向別人說(shuō)明你的數(shù)據(jù)庫(kù)結(jié)構(gòu)固蚤，如各個(gè)字段的釋義等娘汞。
-
說(shuō)明文檔（查看Demo ）
你完全可以使用showdoc來(lái)編寫(xiě)一些工具的說(shuō)明書(shū),也可以編寫(xiě)一些技術(shù)規(guī)范說(shuō)明文檔以供團(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)限管理
-
公開(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è)置。
-
項(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)限）
-
-
編輯功能
-
markdown編輯
ShowDoc采用markdown編輯器，無(wú)論是編輯還是閱讀體驗(yàn)都極佳很棒兔仰。如果你不了解Markdown茫负，請(qǐng)?jiān)谒阉饕嫠阉?認(rèn)識(shí)與入門(mén) Markdown"
-
模板插入
在ShowDoc的編輯頁(yè)面，點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板乎赴。插入模板后忍法，剩下的就是改動(dòng)數(shù)據(jù)了，省去了很多編輯的力氣榕吼。
-
歷史版本
ShowDoc為頁(yè)面提供歷史版本功能饿序，你可以方便地把頁(yè)面恢復(fù)到之前的版本。
-
部署到自己的服務(wù)器
-
ShowDoc部署手冊(cè)
使用在線的ShowDoc
如果你沒(méi)有自己的服務(wù)器友题，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc http://www.showdoc.cc
http://www.showdoc.cc 作為在線服務(wù)會(huì)長(zhǎng)期維護(hù)戴质，請(qǐng)放心托管你的文檔數(shù)據(jù)度宦，不用擔(dān)心突然關(guān)站的問(wèn)題踢匣。如對(duì)數(shù)據(jù)非常敏感的個(gè)人或企業(yè)，還是把ShowDoc部署到自己的服務(wù)器比較好戈抄。
