文章目录

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本地化安装使用相关推荐

接口文档管理工具--Yapi安装
前言现在咱们做的项目都是前后端分离的,这样就可以保证前端和后端可以同时进行,但是同时会出现一个问题->前端不知道咱们服务器的接口是怎么定义的,不知道里面的参数应该如何传递.这个时候就需要使用接 ...
移动端接口文档管理工具apizza安装
1.下载谷歌浏览器 2.打开浏览器--更多工具--拓展程序--将apizza插件拖入界面 3.打开浏览器右上角红色图标进入apizza ,ok! 转载于:https://www.cnblogs.com ...
软件团队文档管理工具哪个好？
如今的产研团队无一不需要处理大量的数据和文档,以支持产品的设计.开发和测试.这些文档包括需求分析.功能规格.技术方案.测试用例.用户反馈等,涉及多个部门和角色的协作和沟通.国外知名调查机构曾调查发现, ...
除了Confluence，还有哪些好用的文档管理软件？测评
在早期,文档管理软件主要是为了将企业内部海量的电子文档集中存储.管理,通过设置共享权限进行内部员工的文档分发,有些甚至可能要提供API接口,便于将ERP.OA等系统的文档纳入其中,形成企业文档管理中心 ...
接口文档管理工具showDoc
随着互联网的发展,前后端分离已成为互联网项目开发的业界标准使用方式. 由此而产生的前端开发工程师和后端开发工程师的沟通效率问题. 推荐一个应此而生的文档管理工具---showdoc showdoc官网 ...
showDoc项目文档管理工具
ShowDoc是什么每当接手一个他人开发好的模块或者项目,看着那些没有写注释的代码,我们都无比抓狂.文档呢?!文档呢?!Show me the doc !! 程序员都很希望别人能写技术文档,而自己却 ...
一款适合IT团队的在线API文档、技术文档工具-showdoc介绍
还在为word文档传来传去查阅不方便而烦恼吗,还在为查看数据库字段含义不方便而烦恼吗,还在为编写接口文档而烦恼吗?今天为大家推荐一款适合IT团队的在线API文档.技术文档工具,有免费开源和在线托管的版 ...
推荐一个好用的文档管理服务器-showdoc
一个好用的文档管理服务器-showdoc 一.服务器安装先看使用效果. 文档记录的作用对我们技术人来说是十分重要的.好的文档记录能让我们面对之前出现过的类似问题时候,事半功倍.不至于捡芝麻丢西瓜,一 ...
skydrive硬盘(相册)/G宝盘/Google相册(文档管理,协作平台)/QQ文件中转(硬盘)/rayfile硬盘...
微软skydrive网络硬盘(相册):25G免费空间,单文件最大50M, http://skydrive.live.com G宝盘:1G免费网络硬盘,永久保存 http://www.gbaopan.c ...

团队协作之文档管理-ShowDoc本地化安装使用