广州周立功公司文档写作规范

  • 格式:pdf
  • 大小:5.43 MB
  • 文档页数:74

修订历史版本日期原因V1.00 2008/02/23 发布第一版目录第1章文档写作规范 (4)1.1 概述 (4)1.2 页面 (5)1.2.1 规范要求 (5)1.2.2 图片分解 (6)1.2.3 具体操作 (6)1.3 页眉页脚 (9)1.3.1 规范要求 (9)1.3.2 图片分解 (10)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.2 图片分解 (27)1.6.3 具体操作 (27)1.7 题注 (28)1.7.1 规范要求 (28)1.7.2 图片分解 (29)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.2 图片分解 (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.2 图片分解 (44)1.13.3 具体操作 (44)1.14 参考文献 (44)1.14.1 规范要求 (44)1.14.2 图片分解 (45)1.14.3 具体操作 (45)第2章图片编辑规范 (48)2.1 原理图 (48)2.1.1 规范要求 (48)2.1.2 图片分解 (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)第1章文档写作规范1.1 概述所有文档统一使用Word2003排版,画图工具统一使用Visio2003。

除特别说明外,中文用宋体,西文用Times New Roman,五号,段前0.2行、段后0.2行,单倍行距,首行缩进2字符。

在文档中专业名词必须按表1.1的格式进行书写。

表1.1 专业名词书写格式错误写法正确写法IO I/OMODEM,modem ModemFLASH、flash FlashCAN-Bus CAN-busUart UARTI2C I2CPCLK、V0 P CLK、V010uF、100uH 10μF、100μHRS232 RS-232CRS485 RS-485AD、DA A/D、ADC、D/A、DACLPC2000系列ARM芯片、LPC2000系列ARMLPC2000芯片、LPC2000等建议:在进行Word编辑时选择:“工具”→“选项”→“视图”→在“格式标记”一栏中选中“制表符”、“空格”和“全部”,如图1.1所示。

图1.1 格式标记设置1.2 页面1.2.1 规范要求纸张大小为A4;页边距:上下各2.54cm,左右各3.17cm,装订线0cm;距边界:页眉1.5cm,页脚1.75cm。

1.2.2 图片分解图1.2 页面设置_图片分解1.2.3 具体操作“文件”→“页面设置”→在“页边距”选项卡中进行如图1.3所示设置→切换到“版式”选项卡如图1.4所示设置→“确定”。

图1.3 页边距设置图1.4 版式设置小技巧:[1] 如何改变“标尺”的度量单位?一般“标尺”默认以“字符”为单位,现以改为“厘米”为例:单击菜单栏“工具”→“选项”→在“选项”对话框的“常规”选项卡中进行如图1.5所示设置,即可改变。

图1.5 标尺单位改变[2] 如何查看标尺的具体长度?以查看页下边距为例:鼠标放于标尺的页下边距位置,鼠标变为“↕”形状,如图1.6所示→按住鼠标左键+Alt不放,将显示页下边距的长度2.54cm,如图1.7所示。

图1.6 查看页边距_1图1.7 查看页边距_21.3 页眉页脚1.3.1 规范要求页眉可选。

如需则以如下格式编辑:从正文开始,内容依具体情况而定,采用小五号、宋体(中)、Times New Roman(西)、居中书写。

页脚:页码从正文开始,按阿拉伯数字(Times New Roman、小五号)连续编排,居中书写。

1.3.2 图片分解图1.8 页眉和页脚_图片分解1.3.3 具体操作“视图”→“页眉和页脚”,跳出“页眉和页脚”工具栏,此时页眉和页脚可以编辑,可在其中输入内容,如图1.9所示。

图1.9 页眉和页脚设置小技巧:如何去掉页眉中的横线?选中页眉的内容→“格式”→“边框和底纹”→在“边框”选项卡中如图1.10所示设置。

图1.10 页眉去下划线1.4 目录1.4.1 规范要求目录为可选的,可根据需要添加。

如需添加目录统一以如下格式编辑:z“目录”页一般无页眉和页脚,如需有页码,则必须与正文设置不同;z“目录”二字用四号字、黑体、居中书写,“目”与“录”之间空两格;z一级目录左对齐不需缩进,字体使用:黑体(中)、Times New Roman(西)、小四;页码右对齐,标题与页码间使用“…”连接;z二级目录左对齐缩进0.74厘米,字体使用:宋体(中)、Times New Roman(西)、五号;页码右对齐,标题与页码间使用“…”连接;z三级目录左对齐缩进1.48厘米,字体使用:宋体(中)、Times New Roman(西)、五号;页码右对齐,标题与页码间使用“…”连接。

1.4.2 图片分解图1.11 目录_图片分解1.4.3 具体操作(1)“插入”→“引用”→“索引和目录”→在“目录”选项卡中点击“修改”,如图1.12所示→在跳出的“样式”选项卡中分别选择“目录1”、“目录2”、“目录3”进行修改,如图1.13所示。

图1.12 索引和目录图1.13 索引和目录_样式(2)左对齐与缩进:以二级目录为例,在图1.13中选择“目录2”,单击“修改”→跳出“修改样式”对话框,单击“格式”,在下拉列表中选“段落”,如图1.14所示→在“段落”对话框中进行如图1.15所示设置,即可获得左对齐与缩进0.74厘米。

图1.14 目录2_修改样式图1.15 目录2_段落小技巧:如何使“目录”一页与“正文”具有不同的页眉和页脚(包括页码)?插入一个分节符。

将光标放在目录最后一页的页尾→“插入”→“分隔符”→在“分隔符”选项卡中选“分节符类型”中的“下一页”,插入一个“分节符”。

插入“分节符”后即可在“目录”与“正文”中设置不同的页眉和页脚。

1.5 标题1.5.1 章1.规范要求章为一级标题,位于正文中间;字体使用:华文新魏(中)、Times New Roman(西)、加粗、四号;段前6磅、段后6磅、大纲级别1级、段前分页;章标号统一使用“第X章 标题”,标号选择样式标题1,标号与标题文字之间1个空格。

*注:章的标题在页的首行。

2.图片分解图1.16 章_图片分解3.具体操作(1)项目符号和编号:选中章标题内容,如图1.16中的“文档写作规范”→“格式”→“项目符号和编号”→在“多级符号”选项卡中选择除“无”以外的任意一项→单击选项卡右下角的“自定义”,进行如图1.17所示设置。

图1.17 章_多级符号(2)字体设置:选中标题内容→“格式”→“字体”,如图1.18所示进行设置。

图1.18 章_字体设置(3)段落设置:选中标题内容→“格式”→“段落”→在“缩进和间距”选项卡中进行如图1.19所示设置→在“换行和分页”选项卡中进行如图1.20所示设置。

图1.19 章_缩进和间距图1.20 章_换行和分页1.5.2 节1.规范要求节为二级标题,与正文左对齐;字体使用:黑体(中)、Arial(西)、加粗、小四;段前6磅、段后6磅,大纲级别2级;节标号统一使用“X.X标题”,标号与标题文字间制表位1.02厘米;标号选择样式标题2;在“章”后重新开始编号。

2.图片分解图1.21 节_图片分解3.具体操作(1)大纲级别设置:选中节标题内容→“段落”→在“缩进和间距”选项卡中选择大纲级别为“2级”→“确定”。

(2)项目符号和编号:选中节标题内容→“格式”→“项目符号和编号”→在“多级符号”选项卡中选择除“无”以外的任意一项→单击选项卡右下角的“自定义”→选择级别1进行如图1.22所示设置→选择级别2进行如图1.23所示设置→“确定”。

图1.22 节_1级编号格式设置图1.23 节_2级编号格式设置(3)字体设置:选中节标题内容→“格式”→“字体”→在“字体”对话框中进行如图1.24所示设置。

图1.24 节_字体设置(4)段落设置:选中节标题内容→“格式”→“段落”→在“缩进和间距”选项卡中进行如图1.25所示设置。

图1.25 节_段落设置1.5.3 小节1.规范要求小节为三级标题,与正文左对齐;字体使用:黑体(中)、Arial(西)、加粗、五号;段前6磅、段后6磅,大纲级别3级;小节标号统一使用“X.X.X标题”,标号与标题文字间制表位1.02厘米;标号选择样式标题3;在“节”后重新开始编号。

2.图片分解图1.26 小节_图片分解3.具体操作(1)大纲级别设置:选中小节标题内容→“段落”→在“缩进和间距”选项卡中选择大纲级别为“3级”→“确定”。

(2)项目符号和编号:选中小节标题内容→“格式”→“项目符号和编号”→在“多级符号”选项卡中选择除“无”以外的任意一项→单击选项卡右下角的“自定义”→选择级别1进行如图1.27所示设置→选择级别2进行如图1.28所示设置→选择级别3进行如图1.29所示设置→“确定”。

图1.27 小节_1级编号设置图1.28 小节_2级编号设置图1.29 小节_3级编号设置(3)字体设置:选中小节标题内容→“格式”→“字体”→在“字体”对话框中进行如图1.30所示设置。