引言
软件开发过程会产生设计文档和源代码,源代码都是纯文本文件,可以方便的进行版本管理,多人协作开发。但设计文档要求图文并茂,也有很多版式要求,纯文本格式不能满足,以往多是使用word,excel等office软件编写。
word,excel虽然可以编写文档,但是文件都是二进制格式,不能进行版本管理,不方便差异对比,也不方便多人编辑和合并。而在正规的软件开发过程中,设计文档也经常需要变更和多人协作,因此如果能够使用文本格式来编写设计文档,并满足设计文档的版式和图文要求,则可以让设计文档,也能进行版本管理和多人协作。
软件设计文档的需求
软件设计文档的需求,主要就是章节排版,基本的文本格式调整,表格,图片,图片也主要是UML标准的各种图表,如流程图,序列图,类图等。随着标记语言的发展,现在已完全具备将这些内容完全文本化的条件。
Markdown格式
使用Markdown格式来编写设计文档,就基本可以满足如上需求,但是存在如下问题: