软件工程实践报告撰写要求
- 格式:doc
- 大小:86.00 KB
- 文档页数:8
软件工程实践报告撰写要求
一、软件工程实践报告的内容安排
软件工程实践报告应包括以下7个方面的内容:
1. 摘要 2. 目录 3. (前言) 4.正文 5. 结论 6. 参考文献
7. 附录
二、摘要
1. 要求: 完整、准确、简练。(约150字)
2. 包含内容:
(1) 课题的目的或意义;
(2) 设计工作的主要内容、过程,采用的方法及取得的成果。即:做了什么工作?
(3) 结论或实现的功能。
3. 关键字(Key Words): 一般3~5个,最能代表报告内容特征,或在报告起关键作用,最能说明问题的词组。
4.注意:
(1) 摘要应用第三人称书写;
(2) 不得引用他人的著作;
(3) 摘要应排除本学科已成常识的内容;
(4) 同义词不要并列为关键字。
三、(前言)
前言主要说明为什么要从事本设计工作(课题意义),本课题相关技术的现状与特点,拟采用的方案或路线。
可以有以下的一些内容:
1. 本课题的背景、目的、意义 。
2.国内本课题相关技术的研究或应用状况、特点。
注意:(1) 不要与摘要雷同;
(2) 学科中的常识内容、科普内容不必赘述。
四、正文
正文是整个报告的核心部分,应包括所进行设计或研究的整体内容。
1.数据库类的正文主要包括: (1)(前言)
(2)课题的需求分析(数据流图、数据字典)
分析软件设计的目标和任务,确定软件功能和性能需求。
(3)数据设计(实体关系图)
侧重于实体关系图、数据表的设计和说明。
(4) 概要设计(系统层次结构图)
概要设计定义软件系统各主要成份之间的关系。
(5)详细设计(程序流程图)
把软件系统结构成份转换成软件的过程性描述(算法),用程序流程图详述主要事件的实现过程。然后进行编码-----根据这种过程性描述,编写核心源代码。
(6)调试及测试分析
包括: 调试程序的方法和技巧;列写测试用例和与运行的结果比较分析;调试中出现的故障现象、原因及排除方法。
(7)用户手册
描述如何使用所设计的软件。
2.算法类的正文主要包括:
(1) (前言)
(2) 设计要求:(基本要求,提高要求);
(3) 系统的组成及设计的原理;
(4) 概要设计(系统层次结构图,并包括方案比较)
(5) 详细设计(程序流程图)
把软件系统结构成份转换成软件的过程性描述(算法),用程序流程图详述主要事件的实现过程。然后进行编码-----根据这种过程性描述,编写核心源代码。
(6)调试及测试结果与分析。
包括: 调试程序的方法和技巧;测试的数据和与运行的结果比较分析;调试中出现的故障现象、原因及排除方法。
五、结论 结论是对整个软件设计工作的总结,不只是前面实现功能的简单重复,应概括出整个设计工作的结论性意见或认识,应总结软件实现的特点和方案的优缺点,指出课题的核心及实用价值,也可以提出改进意见和展望,以及课设的收获和体会。
要求:措词严谨、逻辑严密、文字准确。
注意:(1) 不要以第一人称(我)来书写;
(2) 不要对在设计过程中的常识性错误进行讨论。
六、参考文献
本部分列出撰写论文过程中所参考的文章、书本及其它文献。
1. 书写格式:
[序号]→主要作者.→书名.→出版地:→出版社,→ 出版年月
或:
[序号]→主要作者.→文献名.→杂志名,→ 出版年月,→卷号(期号):→页码
2. 举例:
[1] 何鹏飞. Delphi7 程序设计教程.北京:清华大学出版社,2003.
[2] 张玉起.仓库物流管理数据库系统设计.北京:今日科苑,2007年 14期,起止页码:149-150
(按时间顺序)
3. 注意:(1) 作者或责任者不明时,注明“佚名”。
(2) 序号应与文内引用注释号相同。
七、附录
附录应包含一些课题相关的补充材料,如:系统功能层次图,程序清单
‥‥‥等等。附录也需序号和名称,如:
附录 1:系统各功能界面
附录2:程序清单及注释
八、有关论文中插图、表格、公式和单位等问题
1. 插图
(1) 插图要工整、清晰、明了;即: 插图要有自明性
(2) 图号,图名,座标名,标距,单位,注释齐全。
(3) 电气符号需符合国标或国际标准。
2. 表格
(1) 表格要有标号、表名,且写在表格正上方。 (2) 表内不得用“同上”,“同下”,“同左”,“同右”,“//”等。
(3) 注释说明应齐全,写在表下。
插图、表格不得用铅笔或园珠笔绘制。
3. 公式
(1) 公式应单独成行;
(2) 公式应有公式号,必要时可加上式中符号的注释。
4. 插图、表、公式的引用
(1) 在正文中需按插图号、表号、公式号来进行引用;
(2) 插图和表必须在正文中被引用。
5. 单位
(1) 报告中使用单位应按国家法定计量单位制。
如:电流 — kA, A, mA, µA, nA, pA ;
电压 — kV, V, mV, µV
电阻 — GΩ, MΩ, kΩ, mΩ, µΩ
频率 — GHz,MHz,kHz,Hz
时间 — s,ms,µs,ns
„„
(要注意单位符号的大小写)
(2) 有单位的数值必须标上相应的单位。
九、排版、装订格式问题 1. 编排格式:
(1)软件工程实践报告目录
目
录
第一章 XXXXXXXXXXXXXXXXXXX ·························································· XX
1.1 XXXXXXXXXXXXXXXXXXX ··························································· XX
1.1.1 XXXXXXXXXXXXXXXXXXX ···················································· XX
1.2 XXXXXXXXXXXXXXXXXXX ··························································· XX
1.3 XXXXXXXXXXXXXXXXXXX ··························································· XX
第二章 XXXXXXXXXXXXXXXXXXX ·························································· XX
2.1 XXXXXXXXXXXXXXXXXXX ·························································· XX
2.1.1 XXXXXXXXXXXXXXXXXXX ···················································· XX
2.2 XXXXXXXXXXXXXXXXXXX ·························································· XX
第三章 XXXXXXXXXXXXXXXXXXX ·························································· XX
3.1 XXXXXXXXXXXXXXXXXXX ·························································· XX
3.2 XXXXXXXXXXXXXXXXXXX ·························································· XX
第四章 XXXXXXXXXXXXXXXXXXX ·························································· XX
4.1 XXXXXXXXXXXXXXXXXXX ·························································· XX
4.2 XXXXXXXXXXXXXXXXXXX ·························································· XX
第五章 XXXXXXXXXXXXXXXXXXX ··························································· XX
5.1 XXXXXXXXXXXXXXXXXXX ·························································· XX
5.2 XXXXXXXXXXXXXXXXXXX ·························································· XX
参考文献 ················································································································· XX
附录 A ······················································································································ XX
注: 1.三级目录可视情况确定是否上目录。
2.插图号、表号、公式号按章排序,如“图3.1”,“表4-1” 等。 小4号宋体,缩2格, 加粗
小4号宋体, 缩2格,行距22ppt 3号黑体,居中