資訊專(zhuān)欄INFORMATION COLUMN
摘要：用可以非常方便快速地編寫(xiě)出美觀的文檔。同時(shí)也可以將項(xiàng)目導(dǎo)出成文件，以便離線瀏覽。權(quán)限管理公開(kāi)項(xiàng)目與私密項(xiàng)目上的項(xiàng)目有公開(kāi)項(xiàng)目和私密項(xiàng)目?jī)煞N。項(xiàng)目成員你可以很方便地為的項(xiàng)目添加刪除項(xiàng)目成員。
下載地址：https://github.com/star7th/sh...
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文檔 http://www.showdoc.cc/demo?page_id=7 隨著移動(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ù)字典 http://www.showdoc.cc/data-dictionary?page_id=13 一份好的數(shù)據(jù)字典可以很方便地向別人說(shuō)明你的數(shù)據(jù)庫(kù)結(jié)構(gòu)，如各個(gè)字段的釋義等。 說(shuō)明文檔 http://www.showdoc.cc/help?page_id=14
你完全可以使用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)目可供任何登錄與非登錄的用戶(hù)訪問(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)站的其他用戶(hù)。
項(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)谒阉饕嫠阉鳌闭J(rèn)識(shí)與入門(mén) Markdown”
模板插入
在ShowDoc的編輯頁(yè)面，點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后，剩下的就是改動(dòng)數(shù)據(jù)了，省去了很多編輯的力氣。
歷史版本
ShowDoc為頁(yè)面提供歷史版本功能，你可以方便地把頁(yè)面恢復(fù)到之前的版本。
部署到自己的服務(wù)器
ShowDoc部署手冊(cè)
請(qǐng)參考：http://blog.star7th.com/2016/05/2007.html
使用在線的ShowDoc
如果你沒(méi)有自己的服務(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)址showdoc.cc
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://systransis.cn/yun/22955.html
摘要：就是一個(gè)非常適合團(tuán)隊(duì)的在線文檔分享工具，它可以加快團(tuán)隊(duì)之間溝通的效率。部署到自己的服務(wù)器部署手冊(cè)請(qǐng)參考使用在線的如果你沒(méi)有自己的服務(wù)器，但又想使用作為分檔分享工具，你可以使用在線的版權(quán)遵循開(kāi)源協(xié)議發(fā)布，并提供免費(fèi)使用。 ShowDoc是什么 每當(dāng)接手一個(gè)他人開(kāi)發(fā)好的模塊或者項(xiàng)目，看著那些沒(méi)有寫(xiě)注釋的代碼，我們都無(wú)比抓狂。文檔呢？！文檔呢？！Show me the doc ！！ 程序...
摘要：工作后一直在從事開(kāi)發(fā)從以前的大包大攬到現(xiàn)在的退居服務(wù)端寫(xiě)接口當(dāng)中接觸過(guò)幾個(gè)的接口文檔管理工具或系統(tǒng)簡(jiǎn)單描述下功能全面而且簡(jiǎn)潔有用戶(hù)權(quán)限管理功能支持支持導(dǎo)出有多種文檔模板目錄支持兩級(jí)折疊功能強(qiáng)大權(quán)限管理郵件提醒全文搜索插件管理等重收費(fèi)的一個(gè)文 工作后一直在從事PHP開(kāi)發(fā), 從以前的大包大攬到現(xiàn)在的退居服務(wù)端寫(xiě)接口, 當(dāng)中接觸過(guò)幾個(gè)的接口文檔管理工具或系統(tǒng), 簡(jiǎn)單描述下: showdoc...
摘要：總結(jié)如果你在為公司尋找一款開(kāi)源免費(fèi)的開(kāi)發(fā)文檔文檔管理工具，不妨考慮一下項(xiàng)目，一定不會(huì)讓你失望的。 Wizard 是一款開(kāi)源文檔管理系統(tǒng)，項(xiàng)目地址為 https://github.com/mylxsw/wizard。這個(gè)項(xiàng)目是 我 在2017年就開(kāi)始開(kāi)發(fā)的，起初只是想做一款能夠在公司內(nèi)部把Swagger文檔管理起來(lái)的工具，但在這近兩年的時(shí)間里，一直斷斷續(xù)續(xù)的為其添加各種功能，現(xiàn)在終于下決...
摘要：關(guān)于的詳細(xì)介紹，可看好的數(shù)據(jù)字典文檔能夠清晰地反映出數(shù)據(jù)庫(kù)的結(jié)構(gòu)以及相關(guān)釋義，方便技術(shù)人員查閱。自動(dòng)執(zhí)行的情況下，只會(huì)自動(dòng)新增和修改文檔，不會(huì)自動(dòng)刪除文檔主要出于數(shù)據(jù)安全考慮。 介紹 showdoc是一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔、技術(shù)文檔工具。你可以使用Showdoc來(lái)編寫(xiě)在線API文檔、技術(shù)文檔、數(shù)據(jù)字典、在線手冊(cè)。關(guān)于showdoc的詳細(xì)介紹，可看：https://www....
閱讀 1532·2023-04-25 17:41
閱讀 3054·2021-11-22 15:08
閱讀 852·2021-09-29 09:35
閱讀 1615·2021-09-27 13:35
閱讀 3336·2021-08-31 09:44
閱讀 2725·2019-08-30 13:20
閱讀 1947·2019-08-30 13:00
閱讀 2568·2019-08-26 12:12
