團隊協作之文檔管理-ShowDoc本地化安裝使用

文章目錄

• 1. 文檔分類
• 2. ShowDoc 簡介
• 3. ShowDoc 本地安裝及設定
• 4. ShowDoc 使用
• 5. 總結

在團隊協作中除了代碼的版本管理之外，還有文檔管理也是比較重要的，比如資料字典、接口文檔之類的，試想如果背景修改了接口導緻頁面資料顯示不正常，責任在誰呢？如果通過一個文檔來寫明接口的詳細資訊，該傳什麼參數該傳回什麼資料都是清清楚楚，如果修改了接口，隻需要通知前端按照文檔修改即可，且文檔便于維護。

1. 文檔分類

• 協同工具：WPS雲，石墨，有道雲，一起寫
• 接口文檔：

  showdoc

  ,

  eoLinker

  ,

  MinDoc

  ,

  apizza

• 其他：gitbook / blog / mock

2. ShowDoc 簡介

官網：https://www.showdoc.com.cn/

showdoc主要特性：

• 資料字典、接口模闆
• 團隊協作
• 免費開源
• 支援本地化部署

3. ShowDoc 本地安裝及設定

這次示範是基于docker容器技術，

Docker

方式安裝官方文檔：

https://www.showdoc.com.cn/help?page_id=65610

步驟如下：

# 拉取鏡像
docker pull star7th/showdoc 
# 建立存放showdoc資料的目錄
mkdir -p /showdoc_data/html
# 設定檔案夾權限
chmod  -R 777 /showdoc_data
# 運作docker、映射端口并挂載
docker run -d --name showdoc -p 13500:80 -v /showdoc_data/html/:/var/www/html/ star7th/showdoc
           

記得将13500端口添加防火牆放行規則（如果開啟了防火牆），雲服務商的安全組也需要放行這個端口。

然後通路

13500

端口開始安裝:

選擇中文，點選【OK】:

點選【進入網站首頁】，然後去設定一下密碼：

點選登入：

會顯示我的項目，剛開始會有幾個示例項目，點選【管理背景】圖示可以進去做一些設定：

先來設定下管理者密碼：

一般不直接使用管理者賬号，可以自己注冊一個普通賬号，後直接在後他管理添加一個普通賬号來管理項目。

4. ShowDoc 使用

1. 建立項目

   

   這裡選擇正常項目，單頁項目是沒有目錄的，一般我們内部使用的屬于私密項目，可以設定一個密碼才能通路。
2. 團隊管理

   

   建立号項目後我們可設定下團隊，點選右上角【團隊管理】,添加一個團隊：

然後給團隊配置設定人員和項目：

還可以設定【成員權限】：

1. 編寫文檔

打開項目，看到的是空白頁面，右邊有一些功能按鈕，有傳回、分享、建立頁面、建立/管理目錄、編輯頁面、複制、曆史版本、導出、删除、項目管理等功能：

建立一個試試，選擇【API接口模闆】就會自動生成一個示例模闆，直接在這基礎上修改即可：

1. 常見功能

• 分類：建立多個檔案夾來對文檔按業務功能分類
• 移動目錄：在編輯頁面最上面可以選擇目錄
• 排序：在編輯頁面最上面點選頁面排序可以通過拖拽對文檔進行排序
• 導出：在主界面右邊的有個下載下傳圖示，點選可以導出為word格式或markdown格式

5. 總結

showdoc免費開源，支援本地化部署，簡潔實用，适用于小團隊或個人項目使用。

什麼工具是最好的？---- 适合的才是最好的。