怎样才是技术文档的正确书写方式

怎样才是技术文档的正确书写方式

背景

​        作为程序员的你，现在编写技术文档，采用的是什么编辑器？最强大最好用的vim，还是notpad++，或者是word文档、还是网页的富文本编辑器。

​        大家在CSDN上发的第一篇文字，是不是用网页的富文本编辑器写的，反正我是。这样是不是有点low，我也觉得有点low，后来工作当中因为要编写wiki文档，使用Markdown格式文档的频率越来越高。随着使用频率的越来越高，对Markdown文档也是越来越爱，真是完美诠释了“md使用一时爽，一直使用一直爽”。他编码式的文旦书写风格，再适合程序员不过了，而且能很好的转换成pdf等格式。所以在这里言归正传，我就是还给大家推荐Markdown文档编辑的，希望大家可以在写技术文档时候，可以对网站的富文本编辑器说NO，因为使用富文本编辑器对程序员来说确实有点low。同时使用Markdown文本，也便于后续大写在GitHub以及wiki上编写文档。

​        编写Markdown文档这里推荐使用Typora，为什么推荐使用Typora，其主要原因是它能让我们像使用word文档一样的方式来学习使用Markdown文档。我们不必再刻意的去记住#表示一级标题、##表示二级标题、+表示无序列表、***表示加粗等。

Typora下载地址

​ Typora官网

Typora使用

1. 设置标题格式

        设置标题跟Word文档一样，只需要使用选中相应的文本，点击菜单栏的段落设置相应的标题级别即可。

2. 设置无序列表

        设置无序列表与设置标题一样，只需要使用选中相应的文本，点击菜单栏的段落选择无序列表即可。

3. 设置加粗格式

​​        设置加粗格式，只需要使用选中相应的文本，点击菜单栏的格式选择无加粗即可。

• 这个时候你可能会觉得这与使用word没啥区别，对要是就是这个效果，下面看一下Typora的源代码模式。点击左下角的源代码模式，便能看到该文档的源代码，看的多了你也就记住了#表示一级标题、##表示二级标题、+表示无序列表、***表示加粗等。下次便可以用通过源代码来编写Markdown文档。