ShowDoc是什麼

每當接手一個他人開發好的模組或者專案，看著那些沒有寫註釋的程式碼，我們都無比抓狂。文件呢？！文件呢？！Show me the doc ！！

程式設計師都很希望別人能寫技術文件，而自己卻很不希望要寫文件。因為寫文件需要花大量的時間去處理格式排版，想著新建的word文件放在哪個目錄等各種非技術細節。

word文件零零散散地放在團隊不同人那裡，需要文件的人基本靠吼，吼一聲然後上qq或者郵箱接收對方丟過來的文件。這種溝通方式當然可以，只是效率不高。

ShowDoc就是一個非常適合IT團隊的線上文件分享工具，它可以加快團隊之間溝通的效率。

它可以用來做什麼

• 隨著移動網際網路的發展，BaaS（後端即服務）越來越流行。服務端提供API，APP端或者網頁前端便可方便呼叫資料。用ShowDoc可以非常方便快速地編寫出美觀的API文件。

• 一份好的資料字典可以很方便地向別人說明你的資料庫結構，如各個欄位的釋義等。

• 你完全可以使用showdoc來編寫一些工具的說明書,也可以編寫一些技術規範說明文件以供團隊查閱。

它都有些什麼功能

• 分享與匯出

  • 響應式網頁設計，可將專案文件分享到電腦或移動裝置檢視。同時也可以將專案匯出成word檔案，以便離線瀏覽。

• 許可權管理

  • 公開專案與私密專案

    ShowDoc上的專案有公開專案和私密專案兩種。公開專案可供任何登入與非登入的使用者訪問，而私密專案則需要輸入密碼驗證訪問。密碼由專案建立者設定。

  • 專案轉讓

    專案建立者可以自由地把專案轉讓給網站的其他使用者。

  • 專案成員

    你可以很方便地為ShowDoc的專案新增、刪除專案成員。專案成員可以對專案進行編輯，但不可轉讓或刪除專案（只有專案建立者才有許可權）

• 編輯功能

  • markdown編輯

    ShowDoc採用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不瞭解Markdown，請在搜尋引擎搜尋”認識與入門 Markdown”

  • 模板插入

    在ShowDoc的編輯頁面，點選編輯器上方的按鈕可方便地插入API介面模板和資料字典模板。插入模板後，剩下的就是改動資料了，省去了很多編輯的力氣。

  • 歷史版本

    ShowDoc為頁面提供歷史版本功能，你可以方便地把頁面恢復到之前的版本。

部署到自己的伺服器

使用線上的ShowDoc

• 如果你沒有自己的伺服器，但又想使用ShowDoc作為分檔分享工具，你可以使用線上的ShowDoc http://www.showdoc.cc

• http://www.showdoc.cc 作為線上服務會長期維護，請放心託管你的文件資料。

版權

• ShowDoc遵循Apache2開源協議釋出，並提供免費使用。
  版權所有Copyright © 2016 by star7th
  部落格：http://blog.star7th.com
  郵箱：xing7th#gmail.com（把#改為@）
  All rights reserved.

ShowDoc交流群

• ShowDoc使用交流qq群
  群號：564671853
• 如果你覺得ShowDoc好用，可以轉發此文到你的技術社群以支援ShowDoc。感謝支援。