平时在工作中免不了要写技术文档,我们都知道程序员是最不喜欢写技术文档的,或者说不喜欢写word文档(概要设计、详细设计、系统架构设计文档)。由于程序经常会修改或者变化,程序一旦改变对应的技术文档就要更新,这样会增加很多工作量。所以大家都不喜欢写文档。随着markdown用得越来越多程序员已经慢慢从word文档中转换成写markdown文档了。随着团队人员增加,团队的协作团队共享越来越多,所以类似文档协作软件孕育而生,比如:语雀、Baklib、Docsify等,这些都挺好的不过有的是收费的,有的是云端的,有没有一款私有化还免费的软件呢?答案是有的,就是我们今天分享的ShowDoc。官方的地址https://www.showdoc.com.cn/.目前github有他开源的下载地址 https://github.com/star7th/showdoc
软件的安装也比较简单,大家可以参考https://www.showdoc.com.cn/help/2511252204165611实现安装,这里就不在介绍。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用今天重点给大家介绍这块私有化文档协作平台如何使用的。
1 项目管理1.1 新建项目点击“新建项目”,弹出项目新建窗口,填入项目名及描述。
1.2 复制项目
选择“复制项目”可从已有项目中进行复制修改。
2 新建目录
(1)项目新建好后,点击进入项目,下拉按钮“新建/管理目录”,进行目录设置
(2)点击“添加目录”,输入目录名,可选择上级目录
(3)通过操作区按钮,可对目录进行修改删除移动等操作。
编辑目录 添加子目录 排序 复制/移动目录
3 新建页面3.1 新建页面
下拉按钮“新建页面”,进行页面编辑
3.2 编辑页面
(1)输入文章标题、选择目录
(2)编辑区可对文本内容进行字体格式、排序、标题设置、插入图片、链接、代码块等操作。
(3)模板区域可点击模板直接使用、编辑
(4)点击保存,发布文档
3.3 修改页面
下拉按钮“编辑页面”,可进行再次编辑
4 团队管理4.1 新建团队
团队管理功能模块主要功能是为了方便部门或者某个组织团队创建共享的文档分享平台的,下面介绍具体操作和功能介绍
点击团队管理
我们在右上角可以添加 团队成员例如:XXX 团队
点击确定后完成 团队添加
成员和项目这块很好理解就是添加团队中的成员和 某个项目
点击添加成员,从成员列表中选择需要增加的用户
在项目中点击添加绑定项目,在项目列表中选择能够添加的项目
添加完成后,我们就可以分别看到成员和项目添加完成。
这个时候 添加的成员就会拥有改进项目的权限了
可以看到该用户能访问的项目权限以及项目的所有模块权限了。当然我们如果想让部分人拥有部分模块的权限,而不是项目的所有权限怎么处理呢?在绑定项目中成员权限中设置其中,权限可以设置为 编辑成员、制度成员、项目管理员等权限;目录权限中可以设置所有目录或者某个模块的权限
4.2 项目转让
如果项目出现离职人员的时候,我可以把新建的项目转让给其他在职人员。点击 “转让” 填写 转让的人员,转让的人就拥有该项目的权限了。
用 转让后的人员登录就可以看到转让的项目了
4.3 分享给其他人员
选择需要风险的页面,点击 分享,这样就可以让没有权限登录该系统的人员访问当前页面
勾选我要创建单页面地址
把分享的页面地址分享给你们小伙伴,如果不勾选 分享的页面只能是拥有该系统权限的用户访问
我们就能够看到分享的页面了,是不是非常简单。
,