hello,小夥伴們,大家好,今天給大家推薦這個開源項目
ShowDoc
是非常適合IT團隊在線共享文檔的工具。一個非常適合IT團隊的在線API文檔,技術文檔工具.感興趣的小夥伴不妨去看一下。
ShowDoc是什麼?
-
每當接手一個他人開發好的模塊或者項目,看着那些沒有寫註釋的代碼,我們都無比抓狂。文檔呢?!文檔呢?!Show me the doc !!
-
程序員都很希望別人能寫技術文檔,而自己卻很不希望要寫文檔。因爲寫文檔需要花大量的時間去處理格式排版,想着新建的word文檔放在哪個目錄等各種非技術細節。
-
word文檔零零散散地放在團隊不同人那裏,需要文檔的人基本靠吼,吼一聲然後上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當然可以,只是效率不高。
-
ShowDoc就是一個非常適合IT團隊的在線文檔分享工具,它可以加快團隊之間溝通的效率。
它可以用來做什麼?
API文檔(查看Demo)
- 隨着移動互聯網的發展,BaaS(後端即服務)越來越流行。服務端提供API,APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
數據字典(查看Demo)
- 一份好的數據字典可以很方便地向別人說明你的數據庫結構,如各個字段的釋義等。
說明文檔(查看Demo)
- 你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規範說明文檔以供團隊查閱
多平臺
showdoc支持網頁版、手機app版和電腦客戶端版。客戶端地址可見:https://www.showdoc.cc/clients
使用在線的ShowDoc
1.如果你沒有自己的服務器,但又想使用ShowDoc作爲分檔分享工具,你可以使用在線的ShowDoc
2.在線showdoc作爲在線服務會長期維護,請放心託管數據
頁面展示
功能展示
開源地址: https://github.com/star7th/showdoc
中文文檔:https://www.showdoc.cc/help?page_id=1385767280275683
今天的推薦不知道大家喜歡嗎?如果你們喜歡話,請在文章底部留言或點贊,以表示對我的支持,你們的留言,點贊,轉發關注是我持續更新的動力哦!
關注公衆號回覆:"1024
",免費領取一大波學習資源,先到先得哦!