关于技术文档写作格式的规定.doc

《关于技术文档写作格式的规定.doc》由会员上传分享，免费在线阅读，更多相关内容在工程资料-天天文库。

1、关于技术文档写作格式的规定2008、8、6本文规定技术文档写作的标准格式，包括字体，字号，标题嵌套约定，行间距，插图、表格的绘制方法和标注方法，加黑，特殊颜色字体的使用，缩进，。。。。执行本规定的意义：使不同撰写人的文档规范统一，便于公司统一整理和留存，也便于执行必要的再编辑工作。一、字体全文一律使用宋体二、字号封面标题三号宋体加黑单文件标题四号宋体加黑正文（含图表标题）一律用五号宋体，不加黑单文件内一级标题五号宋体加黑三、标题嵌套举例说明如下：4.XXX型YYY使用说明①概述本产品。。。。。。（不要在上述黑体字“概述”后面同行开始正文，应换行，下同）②功能介绍

2、⑴。。。。功能；A．AbcdeB．fghija.b.1)2)四、行间距一律使用单倍行距（美观，节约纸张，统一视觉效果）五、插图插图必须用Windows系统的“绘图”工具来绘制，或者将原始图粘贴到“绘图”中后再拷贝到文档中。不允许在WORD中直接绘制，避免文件编辑时发生错误。插图的名称标注方法：1.位置：在图下，首字符从第10列开始2.字体字号：5号宋体不加黑3.序号写法：图12XXX型YYY接线端子图4.插图左右方空白位置不能写正文，不采用围绕方式4四、表格表格必须用WORD中的“表格”工具绘制，应能正常进行再编辑。表格的名称标注方法：1.位置：在表格上方，首字

3、符从第10列开始2.字体字号：5号宋体不加黑3.序号写法：表3XXX行YYY器件清单五、加黑文档中对需要加重语气或提醒注意的地方可使用加黑，但不可太滥，可用情况如：1.注意2.特殊说明3.接线图中的端子号，如：J54.其他可能的情况六、特殊颜色字体除器件清单中特别重要的器件以红色标记外，其他文字一律使用黑色，不得使用其他颜色如蓝色等。（插图中的颜色除外）本规定的意义：1.标准保存文档的正常要求2.审阅人签署修改意见时使用红色字体，避免发生混淆七、缩进正文书写应充分利用纸面的宽度，仅在各层次标题处进行缩进以示区别。自然段首行空2格，其他行一律不空格。八、标点符号1

4、.标点符号的使用举例，下面两段很不相同，规定使用前一种。A．现代企业，要求严格的管理。它是企业成功因素的一部分！B．现代企业,要求严格的管理.它是企业成功因素的一部分!2．应正确使用分号，破折号，省略号，删节号3．若有括号在句尾，则标点符号在最后，见下例本产品采用了高档微处理器（见图1）。错误的写法是：本产品采用了高档微处理器。（见图1）十一、上下标和特殊符号的使用1.上标：如107，mm22.下标：如V1，Fx3．正负号，摄氏度：±，℃4．其他特殊符号，可在WORD的“插入-符号”工具中找到十二、外文字母的写法41.字母大小写分清，如：kV,kW,P,f,DN

5、等等。2.字母正斜体要标注清晰。1）正体适用情况：计量单位、数学公式中的运算符号和缩写号、阿拉伯数字、其值不变的数学常数、指数函数、对数函数、三角函数等符号、化学元素符号、电气设备、仪器、元件等的型号。2）斜体适用情况：用字母代表的量和一般函数、物理量符号、表示几何图形点、线、面的字母等。十三、计量单位的使用及写法1．一律采用法定计量单位。2．在单位和阿拉伯数字连写时，单位用字母符号，如：3A,5V,345cal/(kW•h)等等，不用汉字，如：3安培，5吨/小时等等。3．常用的字母大小写定义：小写的：小时，分钟，秒，毫秒hmsms公里，厘米，毫米kmcmmm大

6、写的：交直流电AC/DC功率P=100W频率Hzf=1000MHz电压电流12V3A组合的：速度km/h电量KVA电阻MΩKΩ电感mH电容μF十四、公式的书写方法1.公式一定要有编号，如（1-1），（3-22）等，公式号居稿件的右侧。2.公式的输入要用正规模板，输入时注意正斜体的书写方式。3.公式书写举例。P=VA(2-1)式中P——功率，单位瓦特；V——电压，单位伏特；A——电流，单位安培。十五、修改标记定义文档初稿被审阅时，可能要做一些修改标记，其所表达的含义应予以明确，规定如下：1．修改意见用红色文字写出41.对建议删除的字句，用方框框起来，如：。。。。。

7、。这本来是应该可以实现的基础功能。（建议去掉）2.对需要再斟酌的段落或字句，加下划线提示，如：。。。。。。再上电就好使了。（建议对口语化文字做润色处理）4．对错别字加方框，并紧随其后用红色做修改，如：。。。。。。可是视对讲室内机5．□□这个标记表示要空两格6．//。。。。。。。。。。。//表示本段需要重新写7.其他复杂的意见，可用红色文字插入到原文的适当位置做说明，如：。。。。。。本段的内容与标题不相符，建议修改：1.。。。。2.。。。。3.。。。。4