Showdoc是一款高效、實(shí)用的在線API文檔編輯工具,深受大家喜愛。軟件采用markdown編輯器,你可以用它來輕松編寫各種文檔內(nèi)容,支持用戶從代碼文件中自動(dòng)生成API文檔,還能自行添加多個(gè)團(tuán)隊(duì),分配項(xiàng)目,提高整體的辦公效率!
Showdoc軟件簡介
ShowDoc是一個(gè)非常適合IT團(tuán)隊(duì)的在線API文檔、技術(shù)文檔工具。能夠幫助廣大開發(fā)者和用戶快速編寫出集美觀和實(shí)用為一體的API文檔、數(shù)據(jù)字典文檔、技術(shù)文檔、在線excel文檔等等。支持從代碼自動(dòng)生成API,軟件提供團(tuán)隊(duì)合作、任務(wù)分配等功能,無論是編輯還是閱讀體驗(yàn)都非常不錯(cuò)!
Showdoc軟件特色
數(shù)據(jù)字典( 查看Demo)
一份好的數(shù)據(jù)字典可以很方便地向別人說明你的數(shù)據(jù)庫結(jié)構(gòu),如各個(gè)字段的釋義等。
API文檔( 查看Demo)
隨著移動(dòng)互聯(lián)網(wǎng)的發(fā)展,BaaS(后端即服務(wù))越來越流行。服務(wù)端提供API,APP端或者網(wǎng)頁前端便可方便調(diào)用數(shù)據(jù)。用ShowDoc可以非常方便快速地編寫出美觀的API文檔,同時(shí)還將支持從代碼文件中自動(dòng)生成API文檔
說明文檔(查看Demo )
你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術(shù)規(guī)范說明文檔以供團(tuán)隊(duì)查閱。
Showdoc軟件功能
編輯功能
markdown編輯:ShowDoc采用markdown編輯器,無論是編輯還是閱讀體驗(yàn)都極佳很棒。如果你不了解Markdown,請(qǐng)?jiān)谒阉饕嫠阉?rdquo;認(rèn)識(shí)與入門 Markdown”
模板插入:在ShowDoc的編輯頁面,點(diǎn)擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后,剩下的就是改動(dòng)數(shù)據(jù)了,省去了很多編輯的力氣。
歷史版本:ShowDoc為頁面提供歷史版本功能,你可以方便地把頁面恢復(fù)到之前的版本。
分享與導(dǎo)出
響應(yīng)式網(wǎng)頁設(shè)計(jì),可將項(xiàng)目文檔分享到電腦或移動(dòng)設(shè)備查看。同時(shí)也可以將項(xiàng)目導(dǎo)出成word文件,以便離線瀏覽。
權(quán)限管理
公開項(xiàng)目與私密項(xiàng)目:ShowDoc上的項(xiàng)目有公開項(xiàng)目和私密項(xiàng)目兩種。公開項(xiàng)目可供任何登錄與非登錄的用戶訪問,而私密項(xiàng)目則需要輸入密碼驗(yà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é)作
多平臺(tái)
showdoc支持網(wǎng)頁版、手機(jī)app版和電腦客戶端版??蛻舳说刂房梢姡篽ttps://www.showdoc.com.cn/clients
自動(dòng)化
可從代碼注釋中自動(dòng)生成文檔
搭配的RunApi客戶端,可調(diào)試接口和自動(dòng)生成文檔
更新日志
1、界面簡潔友好
2、性能體驗(yàn)優(yōu)化提升
3、修復(fù)了已知bug