1、格式標準統一
使用markdown進行撰寫策劃文檔,統一使用了markdown的語言格式,因此策劃所撰寫的策劃文檔大致格式相同,而不會出現格式相差較大的情況。
markdown語法統一
2、體積輕量
使用Markdown保存的是純文本式的文本文檔,便於項目組內部的分享,不會出現傳輸10多M策劃文檔的情況。
markdown文檔只有幾KB的大小
3、易於版本管理
3.1 無大文件問題
markdown使用純文本格式進行保存,可以直接使用git進行版本管理。因為文件體積較小,版本管理時也不會出現大文件的問題,不會產生LFS文件(從實際經驗來說,word和excel肯定會出現此問題)佔用服務器資源的情況。
用git進行版本管理,好處多多
3.2 快速定位修改
開發中的改動,程序只需要知道哪裡進行了修改。若使用git圖形客戶端[1],可直接看到前後文件的修改,程序可快速定位修改內容,而不需要策劃進行手動維護(這在實際工作中非常浪費時間)標註。
紅色為刪除,綠色為新增,可快速定位修改內容
4、更新及時,瀏覽方便
實際開發中,策劃文檔往往需要頻繁修改,若通知不及時,就會出現策劃需求和程序開發不一致(此問題非常蛋疼)的情況。
但使用markdown後,策劃修改後只要進行git push,即可將文檔推送到遠端儲存庫,而項目內若是使用了gitlab、gitea等工具,程序打開文檔網頁界面,即可實時查看已渲染完成的Markdown文檔。例如,本文檔在gitee平臺的渲染效果如下圖。
5、鏈接方便
撰寫策劃文檔時,經常需要引用其他策劃已經寫過的內容,但策劃文檔不具備程序語言繼承的高級特性,因此使用鏈接是最為方便的解決方案。但這在Excel和word中,跨文件的鏈接體驗是比較糟糕的。而在Markdown中可以直接通過鏈接的方式,索引到其他策劃的文檔,避免了重複的勞動。若是使用了obsidian等筆記工具,鏈接則是更為簡單方便了。
obsidian擁有多種鏈接方式
6、不足之處
當然使用markdown撰寫策劃文檔,亦存在一些不足之處。
6.1 交互性文檔缺少靈活性。
Markdown在撰寫UI交互類的文檔,靈活性尚有欠缺,但可通過圖片標點的方式解決。
此類交互稿,潛入markdown不夠靈活。摘自:https://blog.csdn.net/qq_45340365/article/details/96874918
6.2 表格使用不方便
Markdown的表格語法是不太不方便的,但表格在策劃文檔中使用的頻率較高。此問題可通過第三方筆記類的軟件解決,例如obsidian。
markdown的表格使用不太方便
6.3有一定學習成本
學習一個新鮮事物總是困難的,即使Markdown只需要不到半個小時就可以大概掌握。
- SmartGit、SourceTree、Fork等圖形git客戶端↩︎