使用Markdown追溯产品文档历史版本

作为产品人，撰写各种文档是日常工作之一。那么大家在写文档的时候，一般都会用word，然后发布成doc/docx、pdf、或者rtf格式的，这种富文本编辑的方式样式很丰富、排版很好看。

但不知大家有没有注意过一个问题，以产品需求文档为例，我们在文档的开头都会制作一个表格来记录文档的变更记录，包括编写人、编写时间、变更内容等等，用来追溯需求文档的版本。那么如果我们严格按照要求每次都填写变更记录的话，是不是会比较麻烦，我们每次都要把修改的东西概括成很简略的文字然后记下来，如果不严格记录，那么到后期查阅时可能会比较麻烦。

那么今天为大家推荐一种轻量级标记语言——Markdown。说到“语言”，大家不被吓到，他不是那种很复杂的编程语言，他是轻量级的，只需要记住几种符号就可以使用。通过简单的标记语法，可以使普通文本具有一定的格式。目前很流行的技术平台WordPress、GitHub、redmine、国内的简书、有道云笔记、印象笔记等等，都支持Markdown。

Markdown有什么好处呢？网上有好多讨论Markdown和富文本的比较，大多围绕着“排版简单且不失美观、不会打断作者写作思路”这个话题谈，当然这也是我喜欢并推荐Markdown的理由之一。但本文我主要想说的是：Markdown能解决上面我们所说的问题——记录版本，追溯变更记录。

Markdown在和一些管理平台结合使用时（比如项目管理平台redmine、代码管理平台Github），这些平台都会把每次修改的内容记录下来，包括内容、时间、人物，并且可以查看不同版本之间的差别，实现版本的追溯。

我们团队人员在查看的时候，只要登录这些平台（每天工作时开发、测试等成员本身就都会使用这些平台），就能直接查看而无需下载，并且每次看到的都是最新版本，非常的方便。如果我们的文档需要给老板、客户团队外部人员查看的话，那么Markdown也支持生成html页面，我们直接把html页面发给客户，他们同样能非常方便的查看，同时Markdown的排版虽然不如富文本那么丰富，但各种级别的标题、加粗与否、链接等内容也都能非常清晰的表现出来，也很简洁大方。

这张图是Redmine管理平台的Wiki截图，我自己做的一个demo，把需求文档以Wiki页面的形式发布。大家可以看到一共有2个版本，并且可以看到版本之间的对比、修改人、修改时间。

PS：redmine是同时支持Markdown和Textile语法（也是一种轻量级标记语言）的，管理员可以在后台设置。

这个是文档的预览图，屏幕分辨率比较高，截图上面的文字比较小~~

转载于:https://blog.51cto.com/pmdrx/1908639