项目文档撰写规范

《项目文档撰写规范》由会员上传分享，免费在线阅读，更多相关内容在教育资源-天天文库。

1、项目设计文档撰写规范项目设计文档集中表明了作者在项目开发工作中获得的新成果，是学生水平的重要依据，是科研领域中的重要文献资料和社会的宝贵财富。为进一步提高文档资料的质量，规范文档格式，特制订本规范。一、文档构成文档包括前置部分、正文部分。具体构成如下：封面前言目录插图索引（必要时）附表索引（必要时）符号、标号、缩略词、首字母缩写、单位、术语、名词等注释表（必要时）前置部分图1（或图2.1）图2·正文结论参考文献致谢正文部分1.11.21.3··1.3.11.3.2··1.3.2.11.3.2.2··表1（或表2.1）表2·章—1···节条款-1-二、书写规定2.1文

2、档书写项目设计文档必须在计算机上输入、编排与打印。摘要、插图和附表索引及符号表等正文前置部分的页码用罗马数字连续编排，正文以后的页码用阿拉伯数字编排。2.2章节及各章标题文档正文分章节撰写，每章应另起一页。各章标题要突出重点、简明扼要。字数一般在15字以内，不得使用标点符号。标题中尽量不采用英文缩写词，对必须采用者，应使用本行业的通用缩写词。2.3层次层次以少为宜，根据实际需要选择，一般不超过四个层次。层次要求统一，但若节下内容无需列条的，可直接列款、项。层次用到哪一层次视需要而定。2.4引用文献引用文献标注方式应全文统一，置于所引内容最末句的右上角，字体与正文字体

3、一致，用小4号宋体（置于右上标时，字体变小）。引用文献应与文中标注一一对应。几处地方引用同一个文献时，文中标注按第一次出现的序号。所引文献编号用阿拉伯数字置于方括号中，如：“…成果[1]”。当提及的参考文献为文中直接说明时，其序号应该用小4号字与正文排齐，如“由文献[8，10~14]可知”。不得将引用文献标注置于各级标题处。2.5名词术语科技名词术语及设备、元件的名称，应采用国家标准或部颁标准中规定的术语或名称。标准中未规定的术语要采用行业通用术语或名称。全文名词术语必须统一。一些特殊名词或新名词应在适当位置加以说明或注解。采用英文缩写词时，除本行业广泛应用的通用缩

4、写词外，文中第一次出现的缩写词应该用括号注明英文全文。2.6数字按国家语言文字工作委员会等七单位1987年发布的《关于出版物上数字用法的试行规定》，除习惯用中文数字表示的以外，一般均采用阿拉伯数字。年份一概写全数，如2000年不能写成00年。2.7公式原则上居中书写。公式序号按章编排，如第1章第一个公式序号为“（1.1）”，附录A中的第一个公式为“（A.1）”等。文中引用公式时，一般用“见式（1.1）”或“由公式（1.1）”。公式中用斜线表示“除”的关系时应采用括号，以免含糊不清，如a/(bcosx)。通常“乘”的关系在前，如acosx/b而不写成（a/b）cosx

5、。2.8插表表格不加左、右边线。表序一般按章编排，如第1章第一个插表的序号为“表1.1”等。表序与表名之间空一格，表名中不允许使用标点符号，表名后不加标点。表序与表名置于表上，居中书写。-6-表头设计应简单明了，尽量不用斜线。全表如用同一单位，将单位符号移至表头右上角，加圆括号。表中数据应正确无误，书写清楚。数字空缺的格内加“―”字线（占2个数字），不允许用“''”、“同上”之类的写法。表内文字说明，起行空一格、转行顶格、句末不加标点。2.9插图插图应与文字紧密配合，文图相符，技术内容正确。选图要力求精练。2.10制图标准插图应符合国家标准及专业标准。机械工程图：采

6、用第一角投影法，严格按照GB4457~4460-84，GB131-83《机械制图》标准规定。电气图：图形符号、文字符号等应符合有关标准的规定。流程图：原则上应采用结构化程序并正确运用流程框图。对无规定符号的图形应采用该行业的常用画法。2.11图题及图中说明每个图均应有图题（由图号和图名组成）。图号按章编排，如第1章第1图的图号为“图1.1”等。图题置于图下，有图注或其他说明时应置于图题之下。图名在图号之后空一格排写。引用图应说明出处。在图题右上角加引用文献号。图中若有分图时，分图号用a)、b)等置于分图之下。图中各部分说明应采用中文（引用的外文图除外）或数字项号，各

7、项文字说明置于图题之下（有分图题者，置于分图题之下）。2.12插图编排插图与其图题为一个整体，不得拆开排写于两页。插图处的页空白不够排写该图整体时，可将其后文字部分提前排写，将图移至次页最前面。2.13参考文献参考文献书写格式应符合GB7714-87《文后参考文献著录规则》。常用参考文献编写项目和顺序规定如下：著作图书文献[序号]作者（3人以内全部写上，3人以上只写3人再加等或etal，作者之间用“，”号）.书名.版次.出版地：出版者，出版年，引用部分起止页翻译图书文献[序号]作者（3人以内全部写上，3人以上只写3人再加等或etal，作者之间用“，”号）.书名.