全能程序员系列(十)--开发人员写不好文档？--Word篇

最近帮小伙伴们检查项目技术文档，各种技术报告、需求规格说明书、详细设计文档等，文档格式和内容真是丰富多彩、花样百出，一份份检查真是累到吐血。难道开发人员除了会写代码，其他技能就不需要掌握了吗？下面就是我整理的一些文档编写的小技巧，也许能让你的文档编写水平有所提升。

1.什么样的技术文档算是好文档？

首先要明确的是技术文档是应用文，不是记叙文、议论文，更不是散文、诗歌、杂文。再缩小下范围应该是说明文，目的就是把一件事情描述清楚。能把一件事情以书面文字的形式并有条理的讲述出来，就是一篇技术文档。

其次技术文档是给人看的，长的好看别人才愿意看下去。然而现实是排版格式漂亮的文档各有各的好看，即使写的很深奥也愿意读下去；排版格式不好的文档只有丑的份，翻两页就压制不住火气打算放弃治疗。所以好的技术文档至少排版格式是要清晰整洁的。

再者技术文档是书面材料，具有一定的严肃性和正式性。读书如读人，在字里行间就能感受到写作者的态度。开发人员在编写文档时是复制粘贴、敷衍了事还是字斟句酌、认真思考都能从文档的细节中体现出来。因此好的技术文档需要开发人员有良好的态度。

2.写一篇技术文档有哪些技巧？

2.1.整体要求

整体风格前后要保持一致，即文档从前到后的字体字号保持一致、段落缩进和行间距保持一致、图片样式保持一致、表格样式保持一致、色彩使用保持一致、用语规范保持一致等，这样整篇文档不会有东拼西凑的感觉。

整体逻辑要通顺，要根据文档的性质分析文档需要达到的目的或者想要表达的内容，从这个目的出发规划整篇文档的逻辑结构，做到提纲挈领、纲举目张。在编写文档时就应先列出文档的纲目，或者根据文档模板的目录结构思考行文逻辑。比如初步设计方案一般是在项目前期进行问题分析、提出解决方案、论证方案的可行性、方案实施的成本概算等，因此整体结构也是按照这个逻辑来的。

2.2.序号及标题

1.标题级数不宜过多，以5级以内为宜；标题级数过多说明文档结构划分有问题，或者可以考虑最低级内容以其他形式展示（如列表或表格）。

2.推荐的标题序号样式（据说是国家政府部门公文书写的正式要求）

一级标题编号：一、二、三
二级标题编号：（一）、（二）、（三）
三级标题编号：1、2、3
四级标题编号：（1）、（2）、（3）
五级标题编号：①、②、③
六级标题编号：a、b、c

3.标题编号的字体字号应与标题保持一致

4.注意标题的缩进，不要让标题缩进过多或者让标题和序号距离太远

5.使用自动序号。尽量不要手动添加序号，一是会错，二是太耗时间。有了自动序号，自动生成目录或导航窗格都是很简单的事情，尤其是对于动辄上百页的技术文档而言，效率提升不是一点点。

2.3.图片

1.图片居中对齐。

2.图片不宜过小，主要内容要能看清楚。

3.图片过大时进行压缩。有时候写完文档就发现，才几十页的文档怎么就几百MB了，检查看看是不是图片体积太大了。很多小伙伴习惯使用插入功能添加图片或者直接复制粘贴进去，这时图片所占用的磁盘空间跟原图片是一致的。使用图片工具中的“压缩图片”，取消“仅应用于此图片”选项勾选，对全文图片进行压缩。

4.为图片添加图号。正式的文档中一般都要为图片添加说明，原理跟序号一致。定义新编号格式“图1”、“图2”…

2.4.表格

1.正文中列表项较多且级别较低时，可以用表格展示。

2.使用表格的“根据窗口自动调整表格”，让表格自动填满整个页面。

3.首行标题栏单元格样式一般为上下居中且左右居中。

4.如有必要首列应为序号，且单元格样式为上下居中和左右居中。

2.5.段落

1.一般首行缩进两字符

2.行间距不宜过大或过小，一般为单倍行距、1.25倍行距或1.5倍行距

3.段前间距、段后间距不宜过大

4.段落可两侧对齐，显得整齐

2.6.字体字号

1.正文字体一般为宋体、微软雅黑等

2.正文字号一般为五号、小四

3.标题字体一般为黑体

2.7.用语及措辞

1.切忌一个逗号到底、没有断句。

2.语句要通顺，逻辑要清楚。

3.使用正确的标点符号。一般不会出现问好、感叹号。

4.使用逻辑连接词。

5.使用正式的书面用语，切忌使用口头语。

2.8.修订

文档修改使用Word修订功能，文档传阅时可以看到修改记录。能够分别看到修订前内容和修订后效果，也可选择是否接受修订。

2.9.页眉页脚页码

1.封面一般不加页码。

2.10.SmartArt

1.使用SmartArt可以快速画出结构图、流程图等

2.11.打印

1.如果需要拷贝到其他电脑打印，将文档另存为PDF格式进行打印，避免格式错乱。

2.如果需要装订，页边距不宜过小，避免盖住正文内容。

3.如果需要装订，封面可以不打印，可以到文印店后单独打印装订。

4.如果有必要尽量双面打印，节省纸张。

2.12.其他

1.以上提到的大部分样式可以预先做在样式库里。

2.如果正文图片、结构图或表格较大，可以调整页面布局，将部分页面改为横向。

3.如果需要将文档拷贝到其他计算机且目标计算机的操作系统版本较低时，可以先将文档另存为97-2003兼容模式。注意部分样式会丢失，尤其是SmartArt对象。

4.Office全家桶之间的很多对象是可以公用的，所以Excel中的表格、Visio中的图形对象、PowerPoint中的图形组合是可以直接拷贝的。

---

抽空多读点书，少玩点游戏少追点剧，不然你人生辞典中的形容词永远只有“卧槽”二字。