内部资料请勿外传
分享人：陈治互联网地图事业部总经理引言软件开发过程会产生设计文档和源代码。源代码都是纯文本文件，方便进行版本管理和多人协作开发。
但设计文档要求图文并茂，同时也有很多版式要求，纯文本格式不能满足，以往多是使用word、excel等office软件编写。word、excel虽然可以编写文档，但是文件都是二进制格式，不能进行版本管理，不方便差异对比，也不方便多人编辑和合并。
而在正规的软件开发过程中，设计文档也经常需要变更和多人协作，因此如果能够使用文本格式来编写设计文档，并满足设计文档的版式和图文要求，则可以让设计文档不仅能进行版本管理，多人协作，还能大大减少文件尺寸。
软件设计文档的需求
软件设计文档的需求，主要就是章节排版，基本的文本格式为表格和图片。图片也主要是UML标准的各种图表（如流程图、序列图、类图等）。随着标记语言的发展，现在已完全具备将这些内容完全文本化的条件。
Markdown格式
使用Markdown格式来编写设计文档就可以基本满足如上需求，但也存在如下问题：
1、Markdown语法不太统一
2、很多支持编写Markdown的软件和网站都要求在线，而根据公司信息安全管理要求对员工上网有限制，同时软件设计文档作为核心IP也不能随便发布到在线网站
3、不同Markdown编辑器对UML的功能支持及编写语法差异很大
因此想很好得让公司内部团队使用Markdown编写文档，需要提供全套的离线编辑软件，工具以及编写流程，统一的编辑环境。
Markdown编辑环境
互联网地图事业部针对业务需求，定制了一套软件设计文档的开发工具集和编写流程，完全可以满足设计文档的编写需求，而且编写效率也有效提升。这个工具集由如下软件和服务构成：
?离线Markdown软件Haroopad
?plantUML图转换服务
?AstahUML编辑软件
?有道云笔记
离线编辑软件Haroopad（v0.13.2）
Haroopad是一款很好用的离线Markdown编辑环境，支持多个操作系统，编写语法基本同Github兼容。其支持如下特性：
?标题
?代码块
?mermaid语法UML图
流程图
序列图
甘特图
?列表内容
?表格
?数学公式
?图片
?任务表