摘要:就是一個非常適合團隊的在線文檔分享工具,它可以加快團隊之間溝通的效率。部署到自己的服務器部署手冊請參考使用在線的如果你沒有自己的服務器,但又想使用作為分檔分享工具,你可以使用在線的版權遵循開源協議發布,并提供免費使用。
ShowDoc是什么
每當接手一個他人開發好的模塊或者項目,看著那些沒有寫注釋的代碼,我們都無比抓狂。文檔呢?!文檔呢?!Show me the doc !!
程序員都很希望別人能寫技術文檔,而自己卻很不希望要寫文檔。因為寫文檔需要花大量的時間去處理格式排版,想著新建的word文檔放在哪個目錄等各種非技術細節。
word文檔零零散散地放在團隊不同人那里,需要文檔的人基本靠吼,吼一聲然后上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當然可以,只是效率不高。
ShowDoc就是一個非常適合IT團隊的在線文檔分享工具,它可以加快團隊之間溝通的效率。
它可以用來做什么API文檔( 查看Demo)
隨著移動互聯網的發展,BaaS(后端即服務)越來越流行。服務端提供API,APP端或者網頁前端便可方便調用數據。用ShowDoc可以非常方便快速地編寫出美觀的API文檔。
數據字典( 查看Demo)
一份好的數據字典可以很方便地向別人說明你的數據庫結構,如各個字段的釋義等。
說明文檔 ( 查看Demo)
你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規范說明文檔以供團隊查閱
它都有些什么功能分享與導出
響應式網頁設計,可將項目文檔分享到電腦或移動設備查看。同時也可以將項目導出成word文件,以便離線瀏覽。
權限管理
公開項目與私密項目
ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問,而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。
項目轉讓
項目創建者可以自由地把項目轉讓給網站的其他用戶。
項目成員
你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯,但不可轉讓或刪除項目(只有項目創建者才有權限)
編輯功能
markdown編輯
ShowDoc采用markdown編輯器,無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown,請在搜索引擎搜索"認識與入門 Markdown"
模板插入
在ShowDoc的編輯頁面,點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板后,剩下的就是改動數據了,省去了很多編輯的力氣。
歷史版本
ShowDoc為頁面提供歷史版本功能,你可以方便地把頁面恢復到之前的版本。
部署到自己的服務器ShowDoc部署手冊請參考:http://blog.star7th.com/2016/05/2007.html
使用在線的ShowDoc如果你沒有自己的服務器,但又想使用ShowDoc作為分檔分享工具,你可以使用在線的ShowDoc http://www.showdoc.cc
版權ShowDoc遵循Apache2開源協議發布,并提供免費使用。
版權所有Copyright ? star7th http://blog.star7th.com All rights reserved.
文章版權歸作者所有,未經允許請勿轉載,若此文章存在違規行為,您可以聯系管理員刪除。
轉載請注明本文地址:http://specialneedsforspecialkids.com/yun/21260.html
摘要:用可以非常方便快速地編寫出美觀的文檔。同時也可以將項目導出成文件,以便離線瀏覽。權限管理公開項目與私密項目上的項目有公開項目和私密項目兩種。項目成員你可以很方便地為的項目添加刪除項目成員。 下載地址:https://github.com/star7th/sh... ShowDoc是什么 每當接手一個他人開發好的模塊或者項目,看著那些沒有寫注釋的代碼,我們都無比抓狂。文檔呢?!文檔呢?!...
摘要:關于的詳細介紹,可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義,方便技術人員查閱。自動執行的情況下,只會自動新增和修改文檔,不會自動刪除文檔主要出于數據安全考慮。 介紹 showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹,可看:https://www....
摘要:關于的詳細介紹,可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義,方便技術人員查閱。自動執行的情況下,只會自動新增和修改文檔,不會自動刪除文檔主要出于數據安全考慮。 介紹 showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹,可看:https://www....
摘要:關于的詳細介紹,可看好的數據字典文檔能夠清晰地反映出數據庫的結構以及相關釋義,方便技術人員查閱。自動執行的情況下,只會自動新增和修改文檔,不會自動刪除文檔主要出于數據安全考慮。 介紹 showdoc是一個非常適合IT團隊的在線API文檔、技術文檔工具。你可以使用Showdoc來編寫在線API文檔、技術文檔、數據字典、在線手冊。關于showdoc的詳細介紹,可看:https://www....
閱讀 2127·2023-05-11 16:55
閱讀 3508·2021-08-10 09:43
閱讀 2624·2019-08-30 15:44
閱讀 2445·2019-08-29 16:39
閱讀 588·2019-08-29 13:46
閱讀 2012·2019-08-29 13:29
閱讀 927·2019-08-29 13:05
閱讀 697·2019-08-26 13:51