技术文档的写作规范

《技术文档的写作规范》由会员上传分享，免费在线阅读，更多相关内容在行业资料-天天文库。

1、技术文档的写作规范　　篇一：技术文件格式要求　　技术文件格式要求　　1目的　　保证技术文件的规范化和标准化，体现公司的管理水平和专业技术人员的技术素质，便于技术文件的正确理解和实施。2范围　　适用于公司范围内的所有项目部，当海外工程另有特殊要求时，可按具体规定执行。3一般要求　　技术文件应贯彻国家、行业、企业的有关法令、规范、规程和标准，充分体现设计意　　图，针对作业项目，起到正确指导作用。　　技术文件应表述简明、逻辑严谨、层次分明，优先选用图表方式描述。技术文件应针对具体作业项目提出明确的要求，避免照抄各种规范标准。文件中的称谓及名词，尽量使用中文，避免使用未经统一

2、的英文字母代号。行文语序必须符合汉语语言规范，不得英文直译。　　正确使用数字、公式、符号、法定计量单位、代号、技术词汇、专业术语。4页面要求　　纸张大小：A4，常规为纵向布置，特殊条件下横向布置。除附图附表外，不宜选用A3　　纸张。附图必须选用大于A4幅面的纸张时，应按国标折叠成A4幅面，以便于装订和存档　　纵向页边距：上25mm，下20mm，左20mm，右20mm。　　横向页边距：上20mm，下20mm，左20mm，右25mm。或在插入分节符后，设置页面横　　置，由WORD自动设置页边距。　　页眉、页脚根据行文需要，当有页眉页脚需要时，页眉顶端距离，页脚底端距离　　

3、厘米；页眉页脚均不加隔离或标识性的横线及方框。　　有装订需要时，纵向布置页面左侧装订，横行布置页面上部装订。装订线位置5mm。根据文本内容需要，同一文本中页面变换时，应在本页面换页处设置分节符。若无特殊要求，不宜设置水印、页面颜色及页面边框。封面不设页眉、页脚以及公司标识等内容。　　正文页眉可使用公司标识，标识尺寸要求见图（公司安全监督处文件《施工现场　　规范标识图册》）。　　图页眉中公司标识示例　　正文页脚可设置文件标识，如“XX装置XX施工技术方案”。　　封面不设页码。目次多于一页时，以“i”、“ii”形式进行编页码。正文页码以“第　　1页共10页”的形式进行编制

4、，居中（无文件标识时）或置于页脚右侧（有文件标识时，双面打印时，偶数页页码置于页脚左侧）。5文件的结构和排版　　文件正文使用小四号宋体字，数字、英文字母可以使用TimesNewRoman，章、节、　　条作为各级标题时使用黑体。　　全文段落倍行距，字间距采用标准格式。　　文章的结构层次不宜超过四级，可分别由章、节、条、款、段、一级列项、二级列项　　组合成文。章节条款应顺序选用，其下均可设段和列项。同一层次中，应按先主后次、共性优先的原则排序。　　文章中的章、节、条、款编号应采用阿拉伯数字，段不编号。层次数字编号之间加半　　角圆点，圆点应加在数字的右下角。各层次的编号及段

5、落、大纲级别示例见表。　　表层次的编号及段落、大纲级别　　注2：章、节、条、款、列项的编号后，与文字之间，除按表中所列插入空格外，不得再有“.”和“、”。　　6标准规范的引用　　国家、行业、企业现行标准、规范只能作为编写方案的依据，应在标题为“编制依据”　　的独立章、节下按项排列。　　不得罗列引用规范标准，文章中未涉及到或未引用到的标准不要列入编制依据。技术　　人员应深入了解其内涵，根据方案内容确定引用范围，确保方案的严谨和准确，同时保证标准规范为最新版本。　　引用标准、规范应按照施工图或设计文件规定的要求。当设计不明确时，引用标准应　　符合下列要求：　　1)所引依据

6、顺序依次为国家标准、本行业标准、其他行业标准、公司施工工艺标准；2)引用规范避免出现双重标准，同是施工或验收规范，不宜出现两个或以上；3)正确区分技术规程、工艺标准、施工（及验收）规范、质量验收规范等标准文件。“编制依据”中标准规范的引用方式应为带“《》”的规范名称，其后为规范编号及发　　行年份。应注意，标准规范的发行年份按规范封面所示正确书写，不应增加或省略。正文中引用标准规范时，应为带“《》”的规范名称，其后在“（）”内注明标准、规范　　的编号和发行年份。　　技术交底中不必出现编制依据，正文中不应出现“执行xxxx－xx标准”、“参照现行　　国家规范”和“遵照公司

7、xx号文件执行”等文字。7插图的规范编制　　每幅图均应在条文中明确提及，并应置于有关条文附近。图的板式应设置为“嵌入型”，　　如果图片较小，可设置为“四周型环绕”或“浮于文字上方”，但不应与文字重叠。条文中的图应按层次号前加“图”字编号。当同一层次中有多个图时，可在层次号后　　加图的顺序号。如：第条有两个图，其图号应分别为“图－1”、“图－2”。对图只能进行一个层次细分成a)、b)、c)等分图。“－”为全角短横线。每幅图应有图题（即图名），并置于图号之后。图号与图题间留一个半角空格间隙，　　并置于图的下方居中位置。图中的分图也宜有图题。图题文字应简练