使用Markdown寫文檔
前言
在工作中，我們經常會遇到需要寫筆記的情況，無論是交接文檔，還是調試日誌，很多需要記錄的內容。最近小黑剛好解決了自己用Markdown記錄的關鍵點，所以分享一下自己的心得。
你的文檔需要管理
文檔管理的認知不是一蹴而就的，只有對文檔重要性有了深刻的認知，才會端正態度去編寫文檔。
這裏小黑簡單總結下自己的文檔記錄歷史。
文檔記錄的四個階段
對文檔的重視在大四的時候就慢慢開始了，當時剛好學習了一本書，叫做《你的知識需要管理》。大意是每個知識工作者，都需要對自己的知識進行管理，學會學習，學會做記錄，學會做總結。通過這本書，對知識的管理開始變得有意識起來，也了解到了知識學習掌握的不同境界，對快速學習一些內容打下了基礎。
對文檔記錄認知的第二個階段是本科畢設和研究生畢設階段，這兩個階段刻意的對排版和文檔質量有了深入的認知了解，也是學格嚴格功夫到家養成的習慣。
第三階段是工作後對文檔的認知。剛工作的時候，發現很多地方缺乏必要的文檔，很多工作文檔也缺乏必要的記錄。做軟件工程師時間長了，慢慢認知到：軟件工程師工作做得不到位，除了軟件寫的不好，還在於文檔寫的不好。
第四階段就是認識了幾位文檔特別仔細的人。劉大的文檔詳細認真、學姐的系統方案專業漂亮，同事的文檔斟字酌句都給我造成了很深的觸動。對文檔規範化、詳細化也有了徹底的認知。
隨著工作時間的增長，慢慢也發現，只有那些願意把文檔寫好的軟件工程師，才會抱著嚴謹認真的態度把事情做好。
選用什麽工具
有了做筆記的意識，就需要有一個好的工具吧。幾經挑選筆記軟件，歷經有道筆記、印象筆記、文檔管理大師。OneNote等，最終決定使用為知筆記作為的文檔記錄工具。
大多數的筆記軟件功能都類似，網上也很多筆記軟件的比較，這裏只介紹一下小黑的選擇依據：
1.首先，這是一個可以做筆記的軟件
2.可以多個終端系統同步，包括手機、PC、筆記本
3.同步速度比較快。OneNote就是由於同步速度拋棄的
4.簡單易用
這些軟件本身選擇哪個不重要，看個人習慣程度，最終還是WIZ筆記我覺得使用很習慣，所以就定了下來。
如何開始文檔記錄
剛開始文檔記錄的時候非常不習慣，通過模仿和學習一些優秀的筆記才慢慢養成了做文檔自己的習慣，如果有興趣可以閱讀以下我是怎樣用為知筆記的。
簡單來說就是，養成筆記習慣，有意識的控制自己的知識存儲，避免用腦袋去完成所有事情的記錄。
為知筆記我從2014年開始使用， 到現在一共使用了3年半的時間，越來越離不開文檔記錄的習慣。從一開始的免費版用到了現在的收費版，對為知的喜歡也不用多說了。
在長達這麽長時間的使用中，我積累了大約2500+的筆記，記錄了我曾經學習過的各科知識、畢設的調試筆記，工作的種種心得和感悟，也算是自己比較自豪的一件事情。
其中有很多很關鍵的KB知識就是自己在解決問題後留下的寶貴財富，如下面對TestStand知識的分類
自己記錄的一些KB如下
使用Markdown做筆記
上面大部分內容都是為Markdown做筆記做鋪墊的，畢竟是近期工作生活的總結嘛。
關於什麽是Markdown，為什麽使用Markdown大家可以自行百度。我的理解就是，如果你需要大量寫作，使用markdown可以讓你對文字排版變得簡單。
為知筆記很早就有了markdown語法，只要文檔名稱後綴添加.md就可以支持。而之前的使用中，體驗一直不好，包括以下幾點：
- 不能實時預覽自己的格式，只能保存後才能觀看
- 不會修改樣式，做出來的文檔有點素
後來慢慢的使用WIZ自帶的編輯器，並輔助快捷鍵進行文檔的編輯，這樣過度了有1年的時間。
再次撿回Markdown
再次使用Markdown是由於上一篇文章中，小黑不會排版微信文章，覺得排版非常費事，所以想要使用Markdown簡化工作，而此時剛好發現WIZ有了一個新的插件，讓Markdown更加直觀簡單了。
這個插件就是Wiz.Editor.md
使用幾天之後，發現好用到爆，完美解決了自己WIZ使用Markdown的所有顧慮。
下面是我認為的非常好用的功能
- 和WIZ兼容的非常完美
- UI非常的簡介美觀
- 支持雙界面預覽
- 支持多種主題樣式的更換，包括Markdown語法的各種代碼高亮顯示
升級版本的Markdown編輯
當然，如果說僅僅是這樣，使用MarkdownPad也差不多，近期又研究了一下CSS，Markdown渲染出來的文檔就相當幫了，主要實現的功能如下：
- 增加了對h1-h5標題的顏色更改，然不同的標題有更加醒目好看的顏色
- 增加了h1-h5的標題編號，實現了跟Word一樣簡單的文檔編號功能
- 調整了一些頁面元素的margin，讓頁面變得更加整齊，最終實現的效果就是這個文檔看到的效果，截圖如下：
後記
由於篇幅關系，這裏只簡單介紹一下自己Markdown語法的一些成果，後續有必要再整理詳細的操作過程，筆記還是都有的~
來自為知筆記(Wiz)
使用Markdown寫文檔