ShowDoc是一個非常適合IT團隊的線上API文件、技術文件工具。透過showdoc,你可以方便地使用markdown語法來書寫美觀的API文件、資料字典文件、技術文件、線上excel文件等等。如果不想編輯markdown文檔,你也可以利用showdoc的自動化能力,從程式註解中自動產生API文檔,或是從搭配的RunApi客戶端(類似postman的api調試工具)中一邊調試接口、一邊自動產生文檔。透過指派專案成員和團隊成員,你可以很方便地進行專案文件的權限管理和團隊協作,也可以分享文件出去給朋友查看。 ShowDoc也支援多平台客戶端,有win客戶端、mac客戶端、ios、android等,更方便跨平台使用。目前超過100000+的網路團隊正在使用showdoc,包括知名公司內部的一些團隊,例如騰訊、華為、百度、京東、位元組跳動、順豐等等。
1、API文檔
隨著行動互聯網的發展,BaaS(後端即服務)越來越流行。服務端提供API,APP端或網頁前端便可方便呼叫資料。用ShowDoc可以非常方便快速地寫出美觀的API文件。
2、資料字典
一份好的資料字典可以很方便地向別人說明你的資料庫結構,例如各個欄位的釋義等。
3、說明文檔
你完全可以使用showdoc來寫一些工具的說明書,也可以寫一些技術規範說明文檔以供團隊查閱。
1、分享與匯出
響應式網頁設計,可將專案文件分享至電腦或行動裝置檢視。同時也可以將項目匯出成word文件,以便離線瀏覽。
2、權限管理
(1)、公開項目與私人項目
ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登入與非登入的使用者訪問,而私人項目則需要輸入密碼驗證訪問。密碼由項目創建者設定。
(2)、專案轉讓
專案創建者可以自由地把專案轉讓給網站的其他使用者。
(3)、專案成員
你可以很方便地為ShowDoc的專案新增、刪除專案成員。專案成員可以對專案進行編輯,但不可轉讓或刪除專案(只有專案建立者才有權限)
(4)、團隊管理
利用showdoc的團隊功能你可以更好地進行團隊協作
3、編輯功能
(1)、markdown編輯
ShowDoc採用markdown編輯器,無論是編輯或閱讀體驗都極佳很棒。如果你不了解Markdown,請在搜尋引擎搜尋”認識與入門Markdown”
(2)、模板插入
在ShowDoc的編輯頁面,點選編輯器上方的按鈕可方便插入API介面範本和資料字典範本。插入模板後,剩下的就是改動數據了,省去了很多編輯的力氣。
(3)、歷史
ShowDoc為頁面提供歷史功能,你可以方便地把頁面恢復到之前的。
4.多平台
showdoc支援、手機app版和電腦用戶端版。
5、自動化
(1)、可從程式碼註解中自動產生文檔
(2)、搭配的RunApi客戶端,可調試介面及自動產生文檔