使用Markdown寫文檔

前言

在工做中，咱們常常會遇到須要寫筆記的狀況，不管是交接文檔，仍是調試日誌，不少須要記錄的內容。最近小黑恰好解決了本身用Markdown記錄的關鍵點，因此分享一下本身的心得。

你的文檔須要管理

文檔管理的認知不是一蹴而就的，只有對文檔重要性有了深入的認知，纔會端正態度去編寫文檔。

這裏小黑簡單總結下本身的文檔記錄歷史。

文檔記錄的四個階段

對文檔的重視在大四的時候就慢慢開始了，當時恰好學習了一本書，叫作《你的知識須要管理》。大意是每一個知識工做者，都須要對本身的知識進行管理，學會學習，學會作記錄，學會作總結。經過這本書，對知識的管理開始變得有意識起來，也瞭解到了知識學習掌握的不一樣境界，對快速學習一些內容打下了基礎。

對文檔記錄認知的第二個階段是本科畢設和研究生畢設階段，這兩個階段刻意的對排版和文檔質量有了深刻的認知了解，也是學格嚴格功夫到家養成的習慣。

第三階段是工做後對文檔的認知。剛工做的時候，發現不少地方缺少必要的文檔，不少工做文檔也缺少必要的記錄。作軟件工程師時間長了，慢慢認知到：軟件工程師工做作得不到位，除了軟件寫的很差，還在於文檔寫的很差。

第四階段就是認識了幾位文檔特別仔細的人。劉大的文檔詳細認真、學姐的系統方案專業漂亮，同事的文檔斟字酌句都給我形成了很深的觸動。對文檔規範化、詳細化也有了完全的認知。

隨着工做時間的增加，慢慢也發現，只有那些願意把文檔寫好的軟件工程師，纔會抱着嚴謹認真的態度把事情作好。

選用什麼工具

有了作筆記的意識，就須要有一個好的工具吧。幾經挑選筆記軟件，歷經有道筆記、印象筆記、文檔管理大師。OneNote等，最終決定使用爲知筆記做爲的文檔記錄工具。

大多數的筆記軟件功能都相似，網上也不少筆記軟件的比較，這裏只介紹一下小黑的選擇依據：
1.首先，這是一個能夠作筆記的軟件
2.能夠多個終端系統同步，包括手機、PC、筆記本
3.同步速度比較快。OneNote就是因爲同步速度拋棄的
4.簡單易用
這些軟件自己選擇哪一個不重要，看我的習慣程度，最終仍是WIZ筆記我以爲使用很習慣，因此就定了下來。

如何開始文檔記錄

剛開始文檔記錄的時候很是不習慣，經過模仿和學習一些優秀的筆記才慢慢養成了作文檔本身的習慣，若是有興趣能夠閱讀如下我是怎樣用爲知筆記的。
簡單來講就是，養成筆記習慣，有意識的控制本身的知識存儲，避免用腦殼去完成全部事情的記錄。

爲知筆記我從2014年開始使用， 到如今一共使用了3年半的時間，愈來愈離不開文檔記錄的習慣。從一開始的免費版用到了如今的收費版，對爲知的喜歡也不用多說了。

在長達這麼長時間的使用中，我積累了大約2500+的筆記，記錄了我曾經學習過的各科知識、畢設的調試筆記，工做的種種心得和感悟，也算是本身比較自豪的一件事情。

其中有不少很關鍵的KB知識就是本身在解決問題後留下的寶貴財富，以下面對TestStand知識的分類

本身記錄的一些KB以下

使用Markdown作筆記

上面大部份內容都是爲Markdown作筆記作鋪墊的，畢竟是近期工做生活的總結嘛。
關於什麼是Markdown，爲何使用Markdown你們能夠自行百度。個人理解就是，若是你須要大量寫做，使用markdown可讓你對文字排版變得簡單。

爲知筆記很早就有了markdown語法，只要文檔名稱後綴添加.md就能夠支持。而以前的使用中，體驗一直很差，包括如下幾點：

1. 不能實時預覽本身的格式，只能保存後才能觀看
2. 不會修改樣式，作出來的文檔有點素

後來慢慢的使用WIZ自帶的編輯器，並輔助快捷鍵進行文檔的編輯，這樣過分了有1年的時間。

再次撿回Markdown

再次使用Markdown是因爲上一篇文章中，小黑不會排版微信文章，以爲排版很是費事，因此想要使用Markdown簡化工做，而此時恰好發現WIZ有了一個新的插件，讓Markdown更加直觀簡單了。

這個插件就是Wiz.Editor.md

使用幾天以後，發現好用到爆，完美解決了本身WIZ使用Markdown的全部顧慮。

下面是我認爲的很是好用的功能

• 和WIZ兼容的很是完美
• UI很是的簡介美觀
• 支持雙界面預覽
• 支持多種主題樣式的更換，包括Markdown語法的各類代碼高亮顯示

升級版本的Markdown編輯

固然，若是說僅僅是這樣，使用MarkdownPad也差很少，近期又研究了一下CSS，Markdown渲染出來的文檔就至關幫了，主要實現的功能以下：

1. 增長了對h1-h5標題的顏色更改，然不一樣的標題有更加醒目好看的顏色
2. 增長了h1-h5的標題編號，實現了跟Word同樣簡單的文檔編號功能
3. 調整了一些頁面元素的margin，讓頁面變得更加整齊，最終實現的效果就是這個文檔看到的效果，截圖以下：

後記

因爲篇幅關係，這裏只簡單介紹一下本身Markdown語法的一些成果，後續有必要再整理詳細的操做過程，筆記仍是都有的~

來自爲知筆記(Wiz)