使用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)