文档写作规范 - 图文

文档写作规范

第 1 页 共 76 页

文档写作规范

文档写作规范

目 录

第1章 文档写作规范 ......................................................................................................................... 4

1.1 概述 ................................................................................................................................... 4 1.2 页面 ................................................................................................................................... 5

1.2.1 规范要求 .................................................................................................................... 5 1.2.3 具体操作 .................................................................................................................... 6 1.3 页眉页脚 ........................................................................................................................... 9

1.3.1 规范要求 .................................................................................................................... 9 1.3.3 具体操作 .................................................................................................................. 10 1.4 目录 ................................................................................................................................. 12

1.4.1 规范要求 .................................................................................................................. 12 1.4.2 图片分解 .................................................................................................................. 12 1.4.3 具体操作 .................................................................................................................. 12 1.5 标题 ................................................................................................................................. 15

1.5.1 章 .............................................................................................................................. 15 1.5.2 节 .............................................................................................................................. 17 1.5.3 小节 .......................................................................................................................... 19 1.5.4 条 .............................................................................................................................. 22 1.5.5 目 .............................................................................................................................. 26 1.6 正文 ................................................................................................................................. 27

1.6.1 规范要求 .................................................................................................................. 27 1.6.3 具体操作 .................................................................................................................. 27 1.7 题注 ................................................................................................................................. 28

1.7.1 规范要求 .................................................................................................................. 28 1.7.3 具体操作 .................................................................................................................. 29 1.8 表格 ................................................................................................................................. 32

1.8.1 规范要求 .................................................................................................................. 32 1.8.2 图片分解 .................................................................................................................. 33 1.8.3 具体操作 .................................................................................................................. 33 1.9 图片 ................................................................................................................................. 34

1.9.1 规范要求 .................................................................................................................. 34 1.9.2 图片分解 .................................................................................................................. 36 1.9.3 具体操作 .................................................................................................................. 38 1.10 程序清单 ........................................................................................................................... 39

1.10.1 规范要求 ............................................................................................................. 39 1.10.3 具体操作 ............................................................................................................. 41 1.11 公式 ................................................................................................................................... 42

1.11.1 规范要求 ............................................................................................................. 42 1.11.2 图片分解 ................................................................................................................. 42

1.11.3 具体操作 ............................................................................................................. 42 1.12 注 ....................................................................................................................................... 43

1.12.1 规范要求 ............................................................................................................. 43 1.12.2 图片分解 ............................................................................................................. 43 1.12.3 具体操作 ............................................................................................................. 43 1.13 附录 ................................................................................................................................... 43

1.13.1 规范要求 ............................................................................................................. 43 1.13.3 具体操作 ............................................................................................................. 44 1.14 参考文献 ........................................................................................................................... 44

1.14.1 规范要求 ............................................................................................................. 44 1.14.3 具体操作 ............................................................................................................. 45

第 2 页 共 76 页

文档写作规范

第2章 图片编辑规范 ....................................................................................................................... 48

2.1 原理图 ............................................................................................................................. 48

2.1.1 规范要求 .................................................................................................................. 48 2.1.3 具体操作 .................................................................................................................. 49 2.2 屏幕截图 ......................................................................................................................... 52 2.3 文档截图 ......................................................................................................................... 52 第3章 文档模板与范例 ................................................................................................................... 54

3.1 产品简介手册 ................................................................................................................. 54 3.2 标准规范手册 ................................................................................................................. 55 3.3 产品应用笔记 ................................................................................................................. 58 3.4 工程技术笔记 ................................................................................................................. 61 3.5 产品数据手册 ................................................................................................................. 64 3.6 产品用户手册 ................................................................................................................. 67 3.7 文档模板说明 ................................................................................................................. 69

3.7.1 样式和格式 .............................................................................................................. 69 3.7.2 编号 .......................................................................................................................... 69 3.8 模板使用 ......................................................................................................................... 71

3.8.1 模板安装 .................................................................................................................. 71 3.8.2 模板使用 .................................................................................................................. 72

第4章 资料备份须知 ....................................................................................................................... 74

4.1 一级目录 ......................................................................................................................... 74 4.2 二级目录 ......................................................................................................................... 74

第 3 页 共 76 页

文档写作规范

第1章 文档写作规范

1.1 概述

所有文档统一使用 Word2003 排版，画图工具统一使用 Visio2003。 除特别说明外，中文用宋体，西文用 Times New Roman，五号，段前 0.2 行、段后 0.2 行，单倍行距，首行缩进 2 字符。 在文档中专业名词必须按表 1.1 的格式进行书写。

表 1.1 专业名词书写格式

错误写法 IO MODEM，modem FLASH、flash CAN-Bus Uart I2C PCLK、V0 10uF、100uH RS232 RS485 AD、DA LPC2000 系列 ARM 芯片、 LPC2000 芯片、LPC2000 等 正确写法 I/O Modem Flash CAN-bus UART I2C PCLK、V0 10μF、100μH RS-232C RS-485 A/D、ADC、D/A、DAC LPC2000 系列 ARM 建议：在进行 Word 编辑时选择：“工具”→“选项”→“视图”→在“格式标记”一

栏中选中“制表符”、“空格”和“全部”，如图 1.1 所示。

第 4 页 共 76 页

文档写作规范

图 1.1 格式标记设置

1.2 页面

1.2.1 规范要求

纸张大小为 A4；页边距：上下各 2.54cm，左右各 3.17cm，装订线 0cm；距边界：页眉 1.5cm，页脚 1.75cm。

第 5 页 共 76 页