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