我为什么建议使用markdown撰写策划文档？

本文系用户投稿，不代表机核网观点

⚠️ 未经作者授权禁止转载

 
1、格式标准统一
使用markdown进行撰写策划文档，统一使用了markdown的语言格式，因此策划所撰写的策划文档大致格式相同，而不会出现格式相差较大的情况。

2、体积轻量
使用Markdown保存的是纯文本式的文本文档，便于项目组内部的分享，不会出现传输10多M策划文档的情况。

3、易于版本管理
3.1 无大文件问题
markdown使用纯文本格式进行保存，可以直接使用git进行版本管理。因为文件体积较小，版本管理时也不会出现大文件的问题，不会产生LFS文件（从实际经验来说，word和excel肯定会出现此问题）占用服务器资源的情况。

3.2 快速定位修改
开发中的改动，程序只需要知道哪里进行了修改。若使用git图形客户端[1]，可直接看到前后文件的修改，程序可快速定位修改内容，而不需要策划进行手动维护（这在实际工作中非常浪费时间）标注。

4、更新及时，浏览方便
实际开发中，策划文档往往需要频繁修改，若通知不及时，就会出现策划需求和程序开发不一致（此问题非常蛋疼）的情况。

但使用markdown后，策划修改后只要进行git push，即可将文档推送到远端储存库，而项目内若是使用了gitlab、gitea等工具，程序打开文档网页界面，即可实时查看已渲染完成的Markdown文档。例如，本文档在gitee平台的渲染效果如下图。

5、链接方便
撰写策划文档时，经常需要引用其他策划已经写过的内容，但策划文档不具备程序语言继承的高级特性，因此使用链接是最为方便的解决方案。但这在Excel和word中，跨文件的链接体验是比较糟糕的。而在Markdown中可以直接通过链接的方式，索引到其他策划的文档，避免了重复的劳动。若是使用了obsidian等笔记工具，链接则是更为简单方便了。

6、不足之处
当然使用markdown撰写策划文档，亦存在一些不足之处。
6.1 交互性文档缺少灵活性。
Markdown在撰写UI交互类的文档，灵活性尚有欠缺，但可通过图片标点的方式解决。

6.2 表格使用不方便
Markdown的表格语法是不太不方便的，但表格在策划文档中使用的频率较高。此问题可通过第三方笔记类的软件解决，例如obsidian。

6.3有一定学习成本
学习一个新鲜事物总是困难的，即使Markdown只需要不到半个小时就可以大概掌握。

SmartGit、SourceTree、Fork等图形git客户端↩︎