软件工程文档规范


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 行。

软件工程文档模板(完整规范版) , 1. 范围 1 2. 总体要求 1 2.1 总体功能要求 1 2.2 软件开发平台要求 1 2.3 软件项目的开发实施过程管理要求 2 2.3.1 软件项目实施过程总体要求 2 2.3.2 软件项目实施变更要求 2 2.3.3 软件项目实施里程碑控制 2 3. 软件开发 3 3.1 软件的需求分析 3 3.1.1 需求分析 3 3.1.2 需求分析报告的编制者 4 3.1.3 需求报告评审 4 3.1.4 需求报告格式 4 3.2 软件的概要设计 4 3.2.1 概要设计 4 3.2.2 编写概要设计的要求 4 3.2.3 概要设计报告的编写者 4 3.2.4 概要设计和需求分析、详细设计之间的关系和区别 4 3.2.5 概要设计的评审 4 3.2.6 概要设计格式 4 3.3 软件的详细设计 5 3.3.1 详细设计 5 3.3.2 特例 5 3.3.3 详细设计的要求 5 3.3.4 数据库设计 5 3.3.5 详细设计的评审 5 3.3.6 详细设计格式 5 3.4 软件的编码 5 3.4.1 软件编码 5 3.4.2 软件编码的要求 5 3.4.3 编码的评审 6 3.4.4 编程规范及要求 6 3.5 软件的测试 6 3.5.1 软件测试 6 3.5.2 测试计划 6 3.6 软件的交付准备 6 3.6.1 交付清单 6 3.7 软件的鉴定验收 7 3.7.1 软件的鉴定验收 7 3.7.2 验收人员 7 3.7.3 验收具体内容 7 3.7.4 软件验收测试大纲 7 3.8 培训 7 3.8.1 系统应用培训 7 3.8.2 系统管理的培训(可选) 8 附录A 软件需求分析报告文档模板 9 附录B 软件概要设计报告文档模板 21 附录C 软件详细设计报告文档模板 33 附录D 软件数据库设计报告文档模板 43 附录E 软件测试(验收)大纲 55
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值