基于Mermaid技术进行文档合作交流
背景
- 项目团队协作需要进行很好的业务流程交流和技术框架交流的需求,流程图、思维导图有相关的平台能够提供相关的技术支持。
- ProcessOn商业化的服务能够提供很好的流程图、类图、时序图、部署架构图等绘制(具有文件大小和数量的限制,有一些开源的流程图绘制可以自己部署例如draw.io)
- naotu.baidu.com能够提供免费的思维导图、鱼骨图等内容的绘制(无使用限制)
思考
- 商业化服务使用到企业应用中必然是有法律风险和可用性风险
- 商业化服务也不利于团队协作和资源管控
- 绘制流程图需要大量的时间去处理配色、大小、布局等功能,但是实际用户只需要结构清晰和快速调整
Mermaid介绍
- 具备Markdown编辑器的插件,能够快速集成多种IDE去使用
- 在线MD编辑器也大都集成了该插件,提供了流程图绘制的功能
- 能够快速绘制流程图、时序图、类图、甘特图等主流图形
- 快速语法变化能够自动重新绘制,适应快速流程变化
- 配合Git等版本管理器能够实现版本管理和回退
综上
建议使用该技术去同步团队的技术流程文档
浙公网安备 33010602011771号