ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率
每當(dāng)接手一個他人開發(fā)好的模塊或者項目，看著那些沒有寫注釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！
程序員都很希望別人能寫技術(shù)文檔，而自己卻很不希望要寫文檔。因為寫文檔需要花大量的時間去處理格式排版，想著新建的word文檔放在哪個目錄等各種非技術(shù)細節(jié)。
word文檔零零散散地放在團隊不同人那里，需要文檔的人基本靠吼，吼一聲然后上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當(dāng)然可以，只是效率不高。
ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。
它可以用來做什么
- API文檔（?查看Demo）
- 隨著移動互聯(lián)網(wǎng)的發(fā)展，BaaS（后端即服務(wù)）越來越流行。服務(wù)端提供API，APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
- 數(shù)據(jù)字典（?查看Demo）
- 一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu)，如各個字段的釋義等。
- 說明文檔 （?查看Demo）
- 你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團隊查閱
它都有些什么功能
- 分享與導(dǎo)出
- 響應(yīng)式網(wǎng)頁設(shè)計，可將項目文檔分享到電腦或移動設(shè)備查看。同時也可以將項目導(dǎo)出成word文件，以便離線瀏覽。
- 權(quán)限管理
- 公開項目與私密項目
- ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創(chuàng)建者設(shè)置。
- 項目轉(zhuǎn)讓
- 項目創(chuàng)建者可以自由地把項目轉(zhuǎn)讓給網(wǎng)站的其他用戶。
- 項目成員
- 你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉(zhuǎn)讓或刪除項目（只有項目創(chuàng)建者才有權(quán)限）
- 團隊管理
- 利用showdoc的團隊功能你可以更好地進行團隊協(xié)作
- 公開項目與私密項目
- 編輯功能
- markdown編輯
- ShowDoc采用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown，請在搜索引擎搜索”認識與入門 Markdown”
- 模板插入
- 在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動數(shù)據(jù)了，省去了很多編輯的力氣。
- 歷史版本
- ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復(fù)到之前的版本。
- markdown編輯
- 多平臺showdoc支持網(wǎng)頁版、手機app版和電腦客戶端版。客戶端地址可見：https://www.showdoc.cc/clients
使用在線的ShowDoc
- 如果你沒有自己的服務(wù)器，但又想使用ShowDoc作為分檔分享工具，你可以使用在線的ShowDoc?http://www.showdoc.cc
- 在線showdoc作為在線服務(wù)會長期維護，請放心托管數(shù)據(jù)
部署到自己的服務(wù)器
- ShowDoc部署手冊請參考：https://www.showdoc.cc/help?page_id=13732
- 開源地址：https://github.com/star7th/showdoc?。若覺得showdoc好用，不妨點個star。良好的關(guān)注度和參與度有助于開源項目的長遠發(fā)展。
- 二次開發(fā)指引https://www.showdoc.cc/help?page_id=1385576954326448
ShowDoc交流群
- ShowDoc使用交流qq群
交流群①：564671853（已滿）
交流群②：174709989（已滿）
交流群③：667194478
