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


3楼猫 发布时间:2023-05-22 12:00:24 作者:金富帅 Language

1、格式标准统一

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

markdown语法统一

2、体积轻量

使用Markdown保存的是纯文本式的文本文档,便于项目组内部的分享,不会出现传输10多M策划文档的情况。
markdown文档只有几KB的大小

markdown文档只有几KB的大小

3、易于版本管理

3.1 无大文件问题

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

用git进行版本管理,好处多多


3.2 快速定位修改

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

红色为删除,绿色为新增,可快速定位修改内容


4、更新及时,浏览方便

实际开发中,策划文档往往需要频繁修改,若通知不及时,就会出现策划需求和程序开发不一致(此问题非常蛋疼)的情况。
但使用markdown后,策划修改后只要进行git push,即可将文档推送到远端储存库,而项目内若是使用了gitlab、gitea等工具,程序打开文档网页界面,即可实时查看已渲染完成的Markdown文档。例如,本文档在gitee平台的渲染效果如下图。

5、链接方便

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

obsidian拥有多种链接方式

6、不足之处

当然使用markdown撰写策划文档,亦存在一些不足之处。

6.1 交互性文档缺少灵活性。

Markdown在撰写UI交互类的文档,灵活性尚有欠缺,但可通过图片标点的方式解决。
此类交互稿,潜入markdown不够灵活。摘自:https://blog.csdn.net/qq_45340365/article/details/96874918

此类交互稿,潜入markdown不够灵活。摘自:https://blog.csdn.net/qq_45340365/article/details/96874918


6.2 表格使用不方便

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

markdown的表格使用不太方便


6.3有一定学习成本

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

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


© 2022 3楼猫 下载APP 站点地图 广告合作:asmrly666@gmail.com