文章目錄

• 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 使用

創建項目

這里選擇常規項目，單頁項目是沒有目錄的，一般我們內部使用的屬于私密項目，可以設置一個密碼才能訪問。

團隊管理

創建號項目后我們可設置下團隊，點擊右上角【團隊管理】,添加一個團隊：

然后給團隊分配人員和項目：


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

編寫文檔

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

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

常見功能

• 分類：新建多個文件夾來對文檔按業務功能分類

• 移動目錄：在編輯頁面最上面可以選擇目錄

• 排序：在編輯頁面最上面點擊頁面排序可以通過拖拽對文檔進行排序

• 導出：在主界面右邊的有個下載圖標，點擊可以導出為word格式或markdown格式

5. 總結

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

什么工具是最好的？---- 適合的才是最好的。

總結

以上是生活随笔為你收集整理的团队协作之文档管理-ShowDoc本地化安装使用的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。