2.6 文档

在本章的最后，笔者想分享一下文档的重要性。很多工程师不够重视文档，只有在软件发布时才会仓促写一些文档，如果公司的管理层不重视，文档就会流于空谈。文档的作用是为了交流，便于团队间的沟通学习，用于未来的你和现在的你交流，所以文档要清楚、简洁。

这里笔者推荐一下Markdown文件格式，比较权威的定义是，Markdown是一种轻量级标记语言，创始人为约翰·格鲁伯（John Gruber）。它允许人们“使用易读易写的纯文本格式编写文档”。它非常轻，普通的文本编辑器就可以使用，可随时随地写作，不用额外购买其他软件。另外，它的语法非常简单，常用的语法用15分钟就可以记住。

Markdown的表现形式也非常丰富，成文后的效果和Word、PDF没有太大的区别。这个工具非常好用，具有丰富的表现形式，而且可使用通用管理工具进行管理，比如通过git就可以实现多人同时共享工作的目的。本书就是用Markdown写成的，可转成Word或PDF文档，从第一次执行git check in命令，大概经历了200多次入仓，才算基本成书。