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

• 官方網(wǎng)站：詳情
• 項(xiàng)目地址：Github
• 使用幫助：詳情

它可以用來(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)限）
  • 團(tuán)隊(duì)管理
    • 利用showdoc的團(tuán)隊(duì)功能你可以更好地進(jìn)行團(tuán)隊(duì)協(xié)作
• 編輯功能
  • markdown編輯
    • ShowDoc采用markdown編輯器，無(wú)論是編輯還是閱讀體驗(yàn)都極佳很棒。如果你不了解Markdown，請(qǐng)?jiān)谒阉饕嫠阉鳌闭J(rèn)識(shí)與入門(mén) Markdown”
  • 模板插入
    • 在ShowDoc的編輯頁(yè)面，點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動(dòng)數(shù)據(jù)了，省去了很多編輯的力氣。
  • 歷史版本
    • ShowDoc為頁(yè)面提供歷史版本功能，你可以方便地把頁(yè)面恢復(fù)到之前的版本。
• 多平臺(tái)showdoc支持網(wǎng)頁(yè)版、手機(jī)app版和電腦客戶端版。客戶端地址可見(jiàn)：https://www.showdoc.cc/clients

使用在線的ShowDoc

• 如果你沒(méi)有自己的服務(wù)器，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc?http://www.showdoc.cc
• 在線showdoc作為在線服務(wù)會(huì)長(zhǎng)期維護(hù)，請(qǐng)放心托管數(shù)據(jù)

部署到自己的服務(wù)器

• ShowDoc部署手冊(cè)請(qǐng)參考：https://www.showdoc.cc/help?page_id=13732
• 開(kāi)源地址：https://github.com/star7th/showdoc?。若覺(jué)得showdoc好用，不妨點(diǎn)個(gè)star。良好的關(guān)注度和參與度有助于開(kāi)源項(xiàng)目的長(zhǎng)遠(yuǎn)發(fā)展。
• 二次開(kāi)發(fā)指引https://www.showdoc.cc/help?page_id=1385576954326448

ShowDoc交流群

• ShowDoc使用交流qq群
  交流群①：564671853（已滿）
  交流群②：174709989（已滿）
  交流群③：667194478

相關(guān)推薦

ShowDoc – 便捷的文檔工具

Muze

• 20年5月12日
• 喜歡：0
• 瀏覽：651

ShowDoc – 便捷的文檔工具

Muze

• 20年5月12日
• 喜歡：0
• 瀏覽：651