产品经理文档神器-showdoc

作为一个产品经理,对于文档的输出,自然是精益求精。毫不夸张地说,产品文档的质量就是产品经理技能的体现。

而一份优秀的文档,跟一个优秀的文档工具是息息相关的。作为神器爱好者,山哥自然也是不敢落后。文档工具也是经历了的office word、google docs、有道笔记、一起写、石墨文档、看云、腾讯文档等等,这些平台都有自己的特色,从安全性、功能齐全、多人协作等,各有千秋大,单也各有特点。

最近接触一个新的文档工具,showdoc。showdoc是一个腾讯的小伙伴开源的自markdown用文档工具,主目前在github上有2921个星,足见这个工具的受欢迎程度,而且作者还保持大概每周一更的频次,极简高效设计,甚是喜欢,推荐给大家。下面一起来看着show有什么神奇的地方:

1、安全

showdoc提供在线版和本地部署版本。在线版本访问地址:https://www.showdoc.cc/,简单注册后就可以使用。登录后台可以看到showdoc提供丰富的权限管理机制,包括访问密码、协作人员和协作团队(可设置编辑和只读权限)。

要是担心资料有可能泄露到网络上,可以在公司服务器部署或者本地局域网部署。具体部署的方案也很简单,最近版本作者已经把代码方案从php+mysql改为php+sqlite,所以只需登录https://github.com/star7th/showdoc下载源代码,把代码复制到服务器www或者htdocs目录下,然后访问页面进行简单的配置即可。关于本地局域网的服务器搭建请参考之前文章:产品经理学技术-PHP服务环境安装

2、多人协作

现在说到文档平台,要没有多人协作,都不好意思拿出来说话。showdoc支持添加个人协作和就团队协作,通过简单设置就可以对对应的人员开放编辑权限。

showdoc其实是thinkphp+editor.md框架二次开发而来,左侧是markdown编辑框,右侧是内容预览。编辑框里可以直接输入内容,也可以直接写markdown语法。平台支持非常完整的markdown语法,支持在线粘贴上传图片,还支持海量的快捷键,具体快捷键请参考:https://www.jianshu.com/p/ba8ac6177db4

同时showdoc还支持强大的版本管理,可以快速还原到对应版本。

4、高效分享

showdoc提供单个页面地址分享,也提供整个项目地址分享,还支持密码访问,高效便捷。

5、高级的浏览功能

1)自适应展示。show浏览界面简洁清爽,支持自适应显示,在手机端和电脑端都可以完美展示。

2)查看文档历史。相信这是很多人产品经理非常需要的,也是很多平台没有的(其他平台是编辑的时候可以编辑者可以查看历史版本,单分享出去后别人是看不到的)。通过showdoc可以清晰查看文档修改细节,具体参看下图效果:


6、一些小扩展:

1)showdoc图片上传地址是绝对路径,不方便迁移,把绝对路径改为相对路径办法:找到PageController.class.php,把文件232行改为get_domain().__ROOT__. 修改为__ROOT__.

2)如果文档大部分场景是PC端,可以考虑把文档的展示区域适当调宽甚至全屏展示,提升效率,调整办法:找到css文件,根据浏览器尺寸,把.doc-container[data-v-54ee2242]下的with改为:1080px~1200px

3)想深入挖掘markdown功能的小伙伴,可参考editor.md官方github:https://pandao.github.io/editor.md/examples/index.html

===============================

本文系大山原创文章,如需转载,请联系作者,谢谢~

你可能感兴趣的:(产品经理文档神器-showdoc)