doc文件怎么编辑（如何愉快地写个文档）

你在工作中写文档吗？

是不是用txt、word或者wiki？

还是其他工具呢，比如showdoc。

在写文档时，有没有不爽的时候呢？

有的话，大家给我分享下哇[灵光一闪]。更好的工具也给我分享下，我学习一下[呲牙]。

我在写文档时，就不想再忍受难用的word或者showdoc了。

但是要用流程图咋办（要在文档即刻编辑，还要方便绘制。不要说viso，processon）[流泪]？

还有文档大家都在修改，怎么和同事汇总呢？

文档今天改了，想知道昨天我改了啥，怎么办呢？

文档能不能和项目版本一起走呢？

不知道，你在用什么工具来写文档呢？

切入正题，今天我就和大家分享下我最近使用的工具。保证解决那些痛点。

使用vscode来写文档。

先别急，我们要用的爽，我才会介绍给大家啊。

为啥用vscode？怎么用的爽呢？

首先，我是程序猿啊[害羞]。当然得用最近热火朝天的工具啦。其实用vscode写个文档就是图方便，图快（比起其他来说很快啦，虽然比txt打开慢了点。不过vscode还是很全能的)。主要还免费，安装也很快（优点太多，说不完啦[鼾睡]）。

我们安装好vscode，再把插件弄好，就可以爽啦！[呲牙][呲牙][呲牙]

要下的插件：markdownlint、Markdown All in One、Draw.io Integration、gitbook kit

vscode用于写文档的工具。其实用jetbrains的ide也行，就是太慢了[流泪]。用起来一点也不爽。vscode插件（Markdownlint、Markdown All in One、Draw.io Integration、Gitbook kit）Markdown All in One、Markdownlint主要提供markdown的预览，添加章节编号，也可以用来直接生成html、pdf文档。Markdownlint主要用于markdown的语法检查。Draw.io Integration主要提供流程图的绘制，包含很多流程图绘制比如：UML、实体关系。还可以安装插件，来增加流程图种类，比如：饼图。最重要是可以直接转换为png图片（此图片非普通图片，嵌入了流程图元数据)，可以直接在markdown引用，且可以在下次直接打开并编辑此图片。 Gitbook kit主要用于对目录的生成。生成gitbook格式的目录，以便在后期生成html时，可以目录浏览，搜索等。

用Draw.io 来绘制流程图

drawio是一个开源好用的流程图的工具。很好用，推荐给大家哦！

刚刚安装好了Draw.io Integration插件，我们就直接用ctrl+shift+p打开命令菜单。输入：drawio，再选中:Draw.io: New Draw.io Diagram。就会提示创建一个draw.io的文件。

比如这里的test.drawio，比如下图：

markdown预览

我们点击test.drawio.png，就可以在VS从的中再打开一个编辑器啦。可以随时编辑，在ctrl+s保存图片。就可以在刚才的文档中实时预览。我们再在中间的文件菜单中转为png（转为test.drawio.png），就可以在markdown中直接引用。

从此再也不用viso和processon啦[紫薇别走]

用git来管理文档

在项目中，常常要和同事一起写文档，还要对历史版本进行管控。我们不得不引入版本库来管理。这样可以跟随项目一起创建版本，一起管理啦。我们上面的都是markdown格式的文档，和png格式的流程图。就算冲突合并也不麻烦啦。

gitbook来生成文档。

我们写了文档，为啥还要用gitbook呢。当然是为了分享发布啦[呲牙]。

用gitbook来对上面的markdown直接生成html文档的站点。配合上gitlab的ci/cd。就可以自动，并及时发布我们的文档网站啦。

当然也可也生成pdf格式的文档。而且gitbook丰富的插件。我们的文档也可以大方美观。显得高大上。