软件工程软件课程实践文档.doc

软件课程实践文档
（参考格式）

项目名称：

项目完毕人：
姓名：
学号：
班号：
姓名：
学号：
班号：
姓名：
学号：
班号：
项目完毕日期：

[文档编制说明：
1. 本文档模板合用于《面向对象技术》课程实践。模板中用方括号括起来的蓝色斜体文本是对指定文档章节应当书写内容和方法的简要提醒，在提交的作业中应当将其删除。项目组应当参考本文档模板撰写文档。此外，考虑到具体项目类型、规模，以及采用的开发过程和方法的差异，项目组可以对文档内容及其格式做适当调整。对于所做的调整，应当在1.5节中加以说明。
2. 内容应当简朴明了、具体详实，并且要“前后一致”，即设计与需求一致，实现与设计一致。特别是在开发原型系统时，应当明确说明对需求、设计和实现的简化或淘汰。]

提交作业情况记录
提交次数
提交日期
提交内容说明

备注

[说明：在提交内容说明一栏里，具体说明本次提交的作业中新增或变更的具体内容，涉及张杰、段落、图表，以及程序中的文献、类或函数等。]

1概述
[说明：本章应提供整个文档的概述。它应涉及本文档的目的、范围、定义、首字母缩写词、缩略语、参考资料和概述。
举例：本文档是本课程实践项目《项目名称》相关文档的汇编，涉及本项目的用户需求规格说明、软件开发计划、软件概要设计说明、软件具体设计说明、软件实现与测试说明、软件安装与使用说明，以及课程实践总结。]

1.1目的
[说明：阐明本文档的目的。
举例：本文档旨在根据对用户需求的分析和论证，编制书面的文档。本文档是本项目开发的重要依据和重要成果，它与软件程序一起构成本项目的最终软件产品。]

1.2范围
[说明：简要说明本文档的范围。
举例：本文档涉及本项目的用户需求规格说明、软件开发计划、软件概要设计说明、软件具体设计说明、软件实现与测试说明、软件安装与使用说明，以及课程实践总结。]

1. 3术语和缩略语定义
[说明：本节应提供对的理解本文档所需的重要术语的定义、首字母缩写词和缩略语。 这些信息可以通过建立项目词汇表来提供。建议格式如下：
中文术语或缩略语（英文相应词）： 术语解释，说明出处、含义等
举例：对于《学生注册系统SRS》，
学生注册（Student Registration）：指学生在一个学期初的指定期间内在学生注册系统中选择并最终拟定本学期选修课程的过程。]

1.4 参考资料
[说明：本节应完整列出本文档中其他部分所引用的任何标准、规范、参考文献和文档等资料。每个文档应标有标题、报告号（假如合用）、日期和出版单位。列出可获取这些参考资料的来源。建议格式如下：
[标记符或编号] 作者，文献名称，出版社名称（或归属单位），日期
[标记符或编号] 作者，文章名，期刊名称或会议名称，日期，刊号（期号）：首页：尾页
举例：
[1] 韩柯等译，Java面向对象编程指南（Beginning Java Objects） ， [美]Jacquie Barker, 电子工业出版社，2023.11
[2] 刘超，《学生注册系统（Student Registration System）需求说明》（面向对象技术课程实践），北京航空航天大学软件工程研究所，2023.9，ftp://211.71.12.139
[3] 刘超，《软件课程实践文档》（面向对象技术课程实践），北京航空航天大学软件工程研究所，2023.2，ftp://211.71.12.139]

1.5 简述
[说明：本节应说明本文档中其他部分所包含的内容，并解释文档的组织方式。
举例：本文档涉及本项目的用户需求规格说明、软件开发计划、软件概要设计说明、软件具体设计说明、软件实现与测试说明、软件安装与使用说明，以及课程实践总结等内容。第二章是用户需求规格说明，具体说明用户的基本需求，并给出本软件的用例模型和相关说明。…]

2 用户需求规格说明
2.1概述
[说明：本章应当从用户的角度，用通俗易懂和准确的语言具体说明本软件产品是什么，用于什么目的，以及相关的产品开发背景，比如当前的工作方式，所使用的产品情况等。]

2.2 产品面向的用户群体
[说明：本章应当从用户的角度，用通俗易懂和准确的语言具体说明本产品面向的用户（客户、最终用户）的特性。]

2.3 产品的业务需求
[说明：本章应当从用户的角度，用通俗易懂和准确的语言具体说明：（1）本产品面向的业务领域及其特性。（2）本产品必须支持的业务活动及其必须遵循的操作规程、业务活动的参与者（人员或外部系统）、各项业务活动必须的输入和产生的输出，以及必需的资源等。
举例：建立用例模型，并具体说明各个用例和相关内容；类图模型，描述领域/业务概念模型；顺序图，描述与用例相相应的各种场景；活地图，描述业务流程；状态图，描述对象类的状态等]

2.4 产品应当遵循的标准或规范
[说明：本章应当从用户的角度，具体说明：本产品应当遵循哪些标准、规范或业务规则。举例：对于《学生注册系统SRS》，应当符合学校有关学生注册的规定。]

2.5 产品的功能性需求
[说明：本章应当从用户的角度，具体说明：(1)产品的功能性需求;(2)产品功能性需求的细化和分解。下表中的功能1、功能1.1等符号应当被替换成有含义的名称。]

表2.5 功能性需求分类
功 能 类 别
子 功 能
说明
功能域 1
功能 1.1

功能 1.2

…

…

2.6 用户界面需求
[说明：本章应当从用户的角度，具体说明：有关用户界面设计和实现方面的规定，以及与其它功能的关系等。]

2.7 软硬件环境需求
[说明：本章应当从用户的角度，具体说明：运营和使用本软件产品所需的软硬件，和对软硬件环境方面的规定等。]

2.8 产品质量需求
[说明：本章应当从用户的角度，具体说明：有关产品质量方面的规定等。
举例：在功能性、可靠性、易用性、安全性、性能等方面的具体规定。]

2.9 其他需求和约束
[说明：本章应当从用户的角度，具体说明：其它方面的规定等。
举例：对课程实践完毕时间的规定等。]

3 软件开发计划
3.1 项目目的和制约条件
[说明：本项目预期的目的和制约条件。
举例：本项目计划是设计并实现本软件的一个原型，涉及…等需求。影响本项目的重要约束有…。]
3.2 任务分工和进度计划
[说明：定义项目过程，分解和细化项目开发工作，具体分派每个成员的任务，并制定进度计划。应当制作进度表，并建议采用Microsoft Project等工具制作Gantt 图。]
表3.1 过程定义简表
活动名称
任务名称及说明
（文档章节和模型图、程序代码、测试用例等）
负责人
起止时间
工作量估计
（页数/小时数）
软件需求分析

软件项目计划

软件概要设计

软件具体设计

编码与单元测试

集成测试

使用说明

4 软件概要设计
[说明:给出软件的该设计，涉及软件的逻辑模型，涉及数据模型、行为模型等，以及用户界面等方面的设计。]

4.1逻辑模型
[说明：采用逻辑模型描述软件系统的结构特性和行为能力，重点是采用类图描述系统中的基本概念和组成成分，及其互相关系，采用状态图、活动图等描述系统的行为，以及其内部对象的操作过程。
举例：根据用例模型，建立软件的逻辑模型，并给出相关内容的具体说明，建立各个模型的数据词典。]

4.1-1 模型简表
模型代码
模型（中文）名称
模型（英文）名称
说明

4.1-xx XX模型元素简表
模型元素代码
模型元素（中文）名称
模型元素（英文）名称
元素类型
说明

4.2 用户界面设计
[说明：用户界面的总体设计方案。
举例：有关窗口、选单、结果视图等的设计。]

4.3 其他说明
[说明：其它设计说明。
举例：对于分布式软件，采用部署模型描述其物理实现方案。]

5软件具体设计
[说明：进一步细化概要设计方案，重点是(1)完毕类图模型的细化工作，针对具体实现方法，增添必要的类、属性或操作，并进行必要的优化。(2)采用构件模型或者列表的方法，说明逻辑模型与物理实现的相应关系。]

6 软件编码与单元测试
[说明：（1）对代码的编写风格，程序的组织等的具体说明。（2）对于每一个单元的测试用立集合。]

7 软件集成测试
[说明：软件集成的测试用例集合及对测试结果的说明。]

8 软件使用说明
[说明：对软件安装和使用方法的说明。]

8.1 软件概述
[说明：对软件重要用途和使用方法的概要说明。]

8.2 软件安装
[说明：对软件重要用途和使用方法的概要说明。]

8.3 软件使用
[说明：对软件启动、各项功能（选单和命令）、数据格式等的说明。]

9 总结
[说明：简要总结进行课程实践的经验和体会，对实践过程中取得的成功经验、出现的问题进行分析。]

附件1 项目组分工及实际完毕情况说明

任务编号
任务名称
内容说明
（文档章节和模型图、程序代码、测试用例等）
数量
（有效行/页数）
实际完毕人

[说明：涉及对各部分文档、各个模型、程序和测试用例的初次编写活动，以及对已有文档、模型和程序的修改活动的记录。]

附件2 软件产品源程序文献清单
[说明：给出软件产品的源程序文献清单，并说明程序编译和运营所需的环境设立。]

附件3 软件产品文档清单
[说明：给出软件产品除源程序文献以外的其它各种软件文档的清单，并作相应的说明。]