软件工程文档规范

来源:互联网 发布:阿里云资源库 编辑:程序博客网 时间:2024/05/22 02:27


1. 纸张要求及页边距

要求采用A4幅面的纸张打印。页边距:上2.6cm,下2.6cm,左2.5cm,右2cm,装订线位置左,装订线1cm,包括页眉和页脚,页码放在页眉右端;评语、任务书、目录等正文前部分的页码用罗马数字单独编排,正文以后的页码用形如第M页,其中M为阿拉伯数字。

2.各级标题的字体字号,页眉、页脚,封面,评语页

采用模板中的格式,不需修改。

3.正文部分

小四字,中文用宋体,英文用Times New Roman,行距20磅。段前、段后0行,但表名、图题的段前、段后均设为0.5行。

4.表格

表序一般按章编排,如“需求分析报告”中第一个插表的序号为“表1-1,“概要设计报告中”第一个插表的序号为“表2-1等。表序与表名之间空一格,表名中不允许使用标点符号,表名后不加标点。表序与表名置于表上,用中文居中排写(表格也居中)。

表头设计应简单明了,尽量不用斜线。表头中可采用化学符号或物理量符号。全表如用同一单位,将单位符号移至表头右上角,加圆括号。

表中数据应正确无误,书写清楚。数字空缺的格内加“-”字线(占2个数字宽度)。表内文字或数字上、下或左、右相同时,采用通栏处理方式,不允许用“″”、“同上”之类的写法。

表内文字说明,起行空一格、转行顶格、句末不加标点。

表格处的该页空白不够排写该表格整体时,则可将其后文字部分提前排写,将表格移到次页最前面。若表格从一页的最前面开始排写,一页仍写不下时,在第二页的最前面应注明“续表×-× 表名”。

所有的表在出现之前应有相应的文字说明,如“……,见表2-1

5.

插图应与文字紧密配合,文图相符,技术内容正确。选图要力求精练。

每个图均应有图题(由图号和图名组成,图号与图名之间空一格)。图号一般按章编排,如“需求分析报告”中第一个图的序号为“图1-1,“概要设计报告中”第一个图的序号为“图2-1等。图题中不允许使用标点符号,图题后不加标点。

图题置于图的下方,用中文居中排写(图也居中)。图中若有分图时,分图号用a)、b)等置于分图之下。

插图与其图题为一个整体,不得拆开排写于两页。插图处的该页空白不够排写该图整体时,则可将其后文字部分提前排写,将图移到次页最前面。

所有的图在出现之前应有相应的文字说明,如“本系统共分为五个功能模块,……,如图3-1所示”。

6. 公式

原则上居中书写。若公式前有文字(如“解”、“假定”等),文字空两格写,公式仍居中写。公式末不加标点。

公式序号按章编排,如第一章第一个公式序号为“(1-1)”,附录A中的第一个公式为(A-1)等。

文中引用公式时,一般用“见式(1-1)”或“由公式(1-1)”。

公式中用斜线表示“除”的关系时应采用括号,以免含糊不清,如1/(bcosx)。通常“乘”的关系在前,如acosx/b而不写成(a/b)cosx

7. 参考文献

参考文献书写格式应符合BG7714-87《文后参考文献著录规则》。常用参考文献编写项目和顺序规定如下:(仅作参考,没有引用者不写引用起止页)

             著作图书文献

  序号      作者. 书名. 版次. 出版者,出版年:引用部分起止页

                                               第一版应省略

              翻译图书文献

  序号      作者.书名. 译者. 版次. 出版者,出版年:引用部分起止页

                                               第一版应省略

              学术刊物文献

  序号      作者. 文章名. 学术刊物名.年,卷(期):引用部分起止页

              学术会议文献

  序号      作者. 文章名. 编者名. 会议名称,会议地址,年份. 出版者,出版年:引用部分起止页

              学位论文类参考文献

  序号      研究生名. 学位论文题目. 学校及学位论文级别. 答辩年份:引用部分起止页

8.其它要求

每章另起一页。在一章中,除最后一页外,每页下方的空行不能超过2行。