在線文檔分享工具ShowDoc

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.