1-2《软件工程课程设计》指导书.doc

软件工程课程设计指导书 安徽工程科技学院 计算机科学与工程系2007年11月版本V2.11. 设计题目本课程设计以项目组为单位，每个项目组从课题选题表中选择一个题目。2设计目的1.通过软件开发的实践训练，使学生进一步理解软件工程介绍的概念、方法和原理等内容，体会软件生存期的各个阶段和软件开发过程。培养学生在软件开发过程的团队精神和在团队中合作的过程。2. 加深对开发过程中所涉及的各种图形工具的认识和理解；学会利用现有的计算机辅助工具独立完成软件系统的开发工作。3. 学会查阅相关手册和资料，通过查阅手册和资料，进一步熟悉用工程化的方法开发系统，并掌握工程化方法的具体含义和如何解决实际问题。4. 认真撰写总结报告，培养严谨的作风和科学的态度。3. 问题描述3.1 问题及要求每个项目组可从建议的题目中选择一个题目，也可以自选感兴趣的题目。自选题目应不低于课题选题表的难度，并在正式设计开始之前书面提交给指导教师审查批准。3.2 选题的依据根据本科学生的知识结构和有限的时间，本课程设计不追求设计出高水平的大型程序，侧重于使学生掌握软件开发的全过程，细心体会每个环节的具体工作，建立起软件开发中“工程”的概念和方法。一方面为后继课程的学习打好基础，另一方面，为以后从事实际软件项目的开发提供了一个参考案例。4时间安排及地点4.1 时间安排课程设计分上机与查资料集中讲解二种方式进行，时间为一周。设计时间为17周，具体进度建议安排如下：4.2 课程设计地点课程设计专用教室，图书馆，计算机系实验室（B座）5组织形式5.1 成立项目组每个小班成立若干个项目组，每个项目组开发一个系统。每项目组2-3人，选举组长1人，负责组织全组的开发工作。项目组由班长协调组织，并将分组结果报告指导老师。5.2 项目组人员分工(建议方案)项目组成员的分工应按照同学的性格、兴趣、特点等安排。可行性研究,需求获取(分析)负责人：1人总体设计,详细设计负责人：1人编码及测试负责人：1人未建议部分的内容可由项目组长负责组织，或组内自行安排。5.3 项目组成员的责任项目组长负责组织全组的开发工作。在开发过程中，当进行到某个具体阶段时，由该阶段的负责人负责组织工作，其他所有人员都是该阶段开发的成员。该阶段的负责人承担该部分的组织工作，其他同学也需要参加部分工作。这种一人负责，多人配合的分工，可以使全体同学都能经历软件开发的每一个阶段的工作，从而得到全面锻炼和提高。6. 开发过程要求按照软件工程的思想和方法开发本系统，每一部分都要有完整的文档。开发过程、内容和提交的成果见附录一。每个项目组选题时需填写课程设计进程安排表提交教师审查。小组成员需填写自己个人的开发日志。日志的内容可以包括:个人在小组中承担任务、计划与进度；相关学科与软件工具学习内容摘要与存在问题、难点；好的创意与建议；开发或学习心得；文档草稿；重要信息与线索记录等。这样做可以有助于项目开发工作和自己的学习，也有助于最后完成个人和小组的课程设计报告。在正式设计的一周中，每天评估一次项目进展情况，若项目进展情况与计划偏离，应采取必要的措施进行调整和解决，以保证开发进度和质量，并将该评估及调整情况记录下来，写入项目开发总结报告中。7课程设计报告撰写规范课程设计结束后，每个项目组撰写一份项目开发报告，每个成员撰写一份个人课程设计总结报告。设计报告的格式见附录二。7.1 报告的要求报告采用打印方式，以书面报告和Word电子文档两种形式提交报告。7.2 报告结构及要求1项目组项目开发报告内容(1) 封面(2) 正文正文应按章节有顺序撰写，要求层次分明，论述清晰，文字简练，方法通顺，图表规范，排版整齐。正文按如下章节编排：1课程设计题目名称2设计所完成的任务要求3系统环境配置和使用工具简单介绍4可行性分析和系统需求分析文档5系统设计文档（包括：系统结构、详细设计以及数据设计等文档）6软件测试（采取的测试策略、测试用例的设计等）7课程设计总结（包括收获和体会以及不足和存在的问题）(3) 附录：附系统相应程序代码(4) 附录：参考文献(资料)参考文献必须是学生在课程设计中真正阅读过或运用过的文献，包括：图书、手册、文章、网上资料等。2个人课程设计总结报告内容（不少于1500字）(1) 项目名称(2) 本人承担的主要任务(3) 本人完成的主要任务(4) 本人对项目的主要贡献(5) 本人的经验和体会7.3 课程设计报告提交日期书面报告提交截止日期：2007年12.月31日电子文档报告及代码提交截止日期：2007年12月31日提交地点和接收人：计算机系老师办公室8设计验收及成绩评定8.1 课程设计成绩的组成本课程设计成绩由四部分组成：文档成绩40%、程序验收30%，创新性成绩10%，个人课程设计报告20%(个人课程设计报告每人一份)每个项目组的每一位学生前80%成绩相同（即该组的成绩），后20%成绩为个人报告成绩。因此，每一位想获得好成绩的同学，都必须在该项目组充分发挥团队精神，尽一切努力去为项目组的成绩而工作。8.2 课程设计成绩评定方法设计成果验收和成绩评定由指导教师和同学共同完成。8.1文档评审与评价（40分）文档评审组成员：课程设计指导教师，每个项目组派1名同学参加工作内容：按照软件工程的思想，审查文档是否齐全，文档内容是否具有完整性、一致性，文档表示是否规范，文档质量如何。文档成绩评定：写出评语，给出初步成绩。8.2 程序验收及设计答辩（30分）验收组成员：课程设计指导教师，每个项目组派1位同学参加。1. 程序验收（30分）验收工作内容：检查各项目组的程序设计成果，分析设计成果是否与文档一致，评价设计质量，评定验收成绩工作程序：项目组代表介绍设计情况、演示系统的功能，验收组提出问题，项目组解答或在计算机上演示成果成绩评定：验收小组讨论，按照软件工程的思想评论各项目组设计完成情况，给出设计成果成绩。8.3创新性评价(10分)由教师和各项目组组长评价各项目的创新性贡献，并给出相应的成绩。课程设计最后成绩由全体指导教师根据各项初步成绩及综合表现评定。8.4个人报告成绩(20分)由全体指导教师审查评定。9工作总结及善后事务处理指导教师认真组织总结本次课程设计工作，总结经验，找出不足并填写课程设计教学小结。10. 课程设计学生守则及管理规定1. 学生在课程设计期间应遵守学校作息制度；请假需经指导教师同意，并按学校规定办理请假手续，否则以旷课论处。2. 学生必须随时接受指导教师的检查，指导及安排的工作。3. 课程设计所使用的机器，须经指导教师同意后，方可使用。课程设计结束后，制作成果必须交院资料室。4. 学生使用的计算机或其它设备，若因责任事故造成丢失或损坏，应酌情赔偿。若设备发生故障，应及时报告，学生不得擅自修理。5. 严格禁止学生在计算机房或实验室玩游戏，每发现一次，则课程设计成绩降低5分。学生不得将计算机房和实验室中的任何设备、器材和工具带回宿舍使用，否则视为盗窃。6. 学生在实验室内和课程设计专用教室内必须严肃认真，不得大声喧哗，严禁吃任何食物，严禁吸烟，每日负责卫生打扫，并在离开时切断电源，关好水龙头，关紧门窗。7. 学生借阅院资料室参考书籍和资料时，必须由指导老师带领，并由指导老师签名借阅。9、 主要参考文献与网址1. 张海藩. 软件工程导论(第四版)，清华大学出版社,，20032. 郑人杰等. 实用软件工程(第二版)，清华大学出版社,19973. Software EngineeringA Practitionaers Approach,Roger S.Pressman, (英文版，第5版),机械工业出版社&McGraw-Hill，20014.文斌，刘长青，田园.软件工程与软件文档写作 ，清华大学出版社，20065./net6.7.中国期刊全文数据库 /kns50/index.aspx8.万方数字化期刊 /wf/html_outside/szhqk/index.html附录一：项目组开发过程、内容及提交的电子文档开发过程工作内容提交文档可行性研究确定项目名称，主要内容，开发的技术方法。根据每个成员的特点进行任务分工。研究本项目的技术可行性、经济可行性、操作可行性可行性研究报告项目开发计划制定项目开发计划，包括：进度计划、人员、资源等项目项目开发计划需求分析进行系统的需求分析，包括：功能要求，非功能要求；用适当的工具表示需求需求规格说明书系统方案选择及功能模块划分确定系统的实现方案，比较各种方案；设计系统总体结构，划分功能模块总体设计报告详细设计设计每个模块内部的结构详细设计报告编码及测试使用某种编程语言进行系统的编码实现，要求给出详细的注释，包括：模块名，模块功能，变量说明等。 所有测试过程要求采用综合测试策略；先作静态分析，再作动态测试。制订测试计划，并保留所有测试用例，完成测试报告。测试计划、测试报告提交整理各种软件工作产品，确定软件产品。完整的软件文档、源代码、可执行代码总结进行项目开发总结课程设计报告注：各种文档可参照软件工程课程提供的范本。对范本中不适用的内容可进行删减。附录二：项目组课程设计报告格式示例软件工程课程设计项目组报告设计题目： 班号： 项目组号： 项目组组长： 项目组成员： 指导教师： 设计开始日期： 设计完成日期： 安徽工程科技学院 计算机科学与工程系2007年12月小四号，宋体，1.5倍行距四号，黑体目 录1课程设计题目名称及设计所完成的任务要求12系统环境配置和使用工具简单介绍33可行性分析和系统需求分析文档44系统设计文档55系统测试66课程设计总结7附录：系统相应主要程序代码9. 附录：参考文献 10注：(1) 页号为参考样例 3号，黑体，居中，加粗设计报告正文样式示例XXX系统设计与实现一级标题，四号，黑体，加粗1.设计所完成的任务要求正文，小四，宋体，1.5倍行距2.系统环境配置和使用工具简单介绍附录：参考文献(资料)序号 作者姓名书名译者版次出版单位出版年份：引用部分起止页码附录三：文档的作用和分类 软件文档(document)也称文件，通常指的是一些记录的数据 和数据媒体，它具有固定不变的形式，可被人和计算机阅读。它和 计算机程序共同构成了能完成特定功能的计算机软件(有人把源程序也当作文档的一部分)。我们知道，硬件产品和产品资料在整 个生产过程中都是有形可见的，软件生产则有很大不同，文档本 身就是软件产品。没有文档的软件，不成其为软件，更谈不到软件 产品。软件文档的编制(documentation)在软件开发工作中占有突 出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档，对于充分发挥软 件产品的效益有着重要意义。 然而，在实际工作中，文档在编制和使用中存在着许多问 题，有待于解决。软件开发人员中较普遍地存在着对编制文档不感 兴趣的现象。从用户方面看，他们又常常抱怨：文档售价太高、文档不够完整、文档编写得不好、文档已经陈旧或是文档太多，难于 使用等等。究竟应该怎样要求它，文档应该写哪些，说明什么问 题，起什么作用?这里将给出简要的介绍。 图 文档桥梁作用 文档在软件开发人员、软件管理人员、维护人员、用户以及计 算机之间的多种桥梁作用可从上图中看出。软件开发人员在各 个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据，这个作用是显而易见的。软件开发过程中软件开发人员需制定 一些工作计划或工作报告，这些计划和报告都要提供给管理人员， 并得到必要的支持。管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等。软件开发人员需为用户了解软 件的使用、操作和维护提供详细的资料，我们称此为用户文档。以 上三种文档构成了软件文档的主要部分。我们把这三种文档所包 括的内容列在下图中。其中列举了十三个文档，这里对它们作 一些简要说明： 可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供 选择的各种可能实施的方案，说明并论证所选定实施方案的理由。 项目开发计划：为软件项目实施方案制定出具体计划，应 该包括各部分工作的负责人员、开发的进度、开发经费的预算、所 需的硬件及软件资源等。项目开发计划应提供给管理部门，并作 为开发阶段评审的参考。 软件需求说明书：也称软件规格说明书，其中对所开发软 件的功能、性能、用户界面及运行环境等作出详细的说明。它是用 户与开发人员双方对软件需求取得共同理解基础上达成的协议， 也是实施开发工作的基础。 数据要求说明书：该说明书应给出数据逻辑描述和数据采 集的各项要求，为生成和维护系统数据文卷作好准备。 概要设计说明书：该说明书是概要设计阶段的工作 成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。 详细设计说明书：着重 描述每一模块是怎样实现的， 包括实现算法、逻辑流程等。 用户手册：本手册详细 描述软件的功能、性能和用户界面，使用户了解如何使用该软件。文档用户文档用户手册操作手册维护修改建议软件需求（规格）说明书开发文档软件需求（规格）说明书数据要求说明书概要设计说明书详细设计说明书可行性研究报告项目开发计划管理文档项目开发计划测试计划测试报告开发进度月报开发总结报告 图 三种文档 操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。 测试计划：为做好组装测试和确认测试，需为如何组织测试 制定实施计划。计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。 开发进度月报：该月报系软件人员按月向管理部门提交的 项目进展情况报告。报告应包括进度计划与实际执行情况的比较、 阶段成果、遇到的问题和解决的办法以及下个月的打算等。 项目开发总结报告：软件项目开发完成以后，应与项目实 施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。 维护修改建议，软件产品投入运行以后，发现了需对其进行修正、更改等问题，应将存在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审批。 以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制。其中有的仅反映一个阶段的工作，有的则需跨越多个阶段。表5给出了各个文档应在软件生存期中哪个阶段编写。这些文档最终要向软件管理部门，或是向用户回答以下的问题： 表9.2 软件生存期各阶段编制的文档 阶段文档可行性研究与计划需求分析设计代码编写测试运行与维护可行性研究报告项目开发计划软件需求说明数据要求说明概要设计说明星系设计说明测试计划用户手册操作手册测试分析报告开发进度月报项目开发总结维护修改建议 哪些需求要被满足，即回答“做什么?” 所开发的软件在什么环境中实现以及所需信息从哪里来， 即回答“从何处?” 某些开发工作的时间如何安排，即回答“何时干?” 某些开发(或维护)工作打算由“谁来干?” 某些需求是怎么实现的? 为什么要进行那些软件开发或维护修改工作? 上述十三个文档都在一定程度上回答了这六个方面的问题。这可从表中看到。表 文档所回答的问题所提问题文档什么 何处 何时 谁 如何 为何 可行性研究报告项目开发计划软件需求说明数据要求说明概要设计说明详细设计说明测试计划用户手册 操作手册 测试分析报告 开发进度月报 项目开发总结 维护修改建议 至此，我们对文档的作用有了进一步的理解。每一个文档的任务也是明确的，任何一个文档都不是多余的。附录四软件开发文档编制指南1可行性研究报告可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能选择的各种方案；说明论证所选定的方案。可行性研究报告的编导内容容要求如下：1.1引言1.1.1编写目的1.1.2背景1.1.3定义1.1.4参考资料1.2可行性研究的前提 1.2.1要求1.2.2目标1.2.3条件、假定和限制1.2.4进行可行性研究的方法1.2.5评价尺度1.3对现有系统的分析1.3.1数据流程和处理流程1.3.2工作负荷1.3.3费用开支1.3.4人员1.3.5设备1.3.6局限性1.4所建议的系统1.4.1对所建议系统的说明1.4.2数据流程各处理流程1.4.3改进之处1.4.4影响对象设备的影响对软件的影响对用户单位机构的影响对系统动行的影响对开发的影响对地点和设施的影响对经费开支的影响1.4.5局限性1.4.6技术条件方面的可行性1.5可选择其他系统方案1.5.1可选择的系统方案11.5.2可选择的系统方案21.6投资及收益分析1.6.1支出基本建设投资其他一次性支出非一次性支出1.6.2收益一次性收益非一次性收益不可定量的收益1.6.3收益/投资比1.6.4投资回收周期1.6.5敏感性分析1.7社会条件方面的可行性1.7.1法律方面的可行性1.7.2使用方面的可行性1.8结论2项目开发计划编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下：2.1引言2.1.1编写目的2.1.2背景2.1.3定义2.1.4参考资料2.2项目概述2.2.1工作内容2.2.2主要参加人员2.2.3产品及成果程序文件服务非移交产品2.2.4验收标准2.2.5完成项目的最迟期限2.2.6本计划的审查者与批准者2.3实施总计划2.3.1工作任务的分解2.3.2接口人员2.3.3进度2.3.4预算2.3.5关键问题2.4支持条件2.4.1计算机系统支持2.4.2需要用户承担的工作2.4.3需由外单位提供的条件2.5专题计划要点3软件需求说明书软件需求说明书的编制是为了使用户和软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下：3.1引言3.1.1编写的目的3.1.2背景3.1.3定义3.1.1参考资料 3.2任务概述3.2.1目标3.2.2用户的特点3.2.3假定与约束3.3需求规定 3.3.1对功能的规定3.3.2对性能的规定精度时间特性要求灵活性3.3.3输入输出要求3.3.4数据管理能力的要求3.3.5故障处理要求3.3.6其它的专门的要求3.4运行环境规定3.4.1设备3.4.2支持软件3.4.3接口3.4.4控制4数据需求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下：4.1引言4.1.1编写目的4.1.2背景4.1.3定义4.1.4参考资料4.2数据的逻辑描述4.2.1静态数据4.2.2动态输入数据4.2.3动态输出数据4.2.4内部生成数据4.2.5数据约定4.3数据的采集4.3.1要求和范围4.3.2输入的承担者4.3.3处理4.3.4影响5概要设计说明书概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下：5.1引言5.1.1编写目的5.1.2背景5.1.3定义5.1.4参考资料5.2总体设计5.2.1需求规定5.2.2运行环境5.2.3基本设计概念和处理流程5.2.4结构5.2.5功能需求与程序的关系5.2.6人工处理过程5.2.7尚未解决的问题5.3接口设计5.3.1用户接口5.3.2内部接口5.3.3外部接口5.4运行设计5.4.1运行模块组合5.4.2运行控制5.4.3运行时间5.5系统数据结构设计5.5.1逻辑结构设计要点5.5.2物理结构设计要点5.5.3数据结构与程序的关系5.6系统出错处理设计5.6.1出错信息5.6.2补救措施5.6.3系统维护设计6详细设计说明书详细说明书可称作程序设计说明书。编制目的是说明一个软件系统各个层次中的每一个程序（每个模块或子程序）的设计考虑，如果一个软件系统比较简单，层次很少，本文件可以不单独编写，有关内容合并概要设计说明书。对详细设计说明书的内容要求如下：6.1引言6.1.1 编写目的6.1.2 背景6.1.3 定义6.1.4 参考资料6.2 程序系统的组织结构6.3 程序1（标识符）设计说明6.3.1 程序描述6.3.2 功能6.3.3 性能6.3.4 输入项6.3.5 输出项6.3.6 算法6.3.7 流程逻辑6.3.8 接口6.3.9 存储分配6.3.10 注释设计6.3.11 限制条件6.3.12 测试计划6.3.13 尚未解决的问题6.4 程序2（标识符）设计说明7数据库设计说明书数据库设计说明书的编制目的是对于设计中的数据库所有标识、逻辑结构和物理结构作出具体的设计规定。其内容要求如下：7.1引言7.1.1编写目的7.1.2背景7.1.3定义7.1.4参考资料7.2外部设计7.2.1标识符和状态7.2.2使用它的程序7.2.3约定7.2.4专门指导7.2.5支持软件7.3结构设计7.3.1概念结构设计7.3.2逻辑结构设计7.3.3物理结构设计7.4运用设计7.4.1数据字典设计7.4.2安全保密设计8用户手册用户手册的编制是要使用非专门术语的语言，充分地描述该软件系统工程所具有的功能及基本的使用方法。使用户（或潜在用户）通过本手册能够了解该软件的用途，并且能够确定在什么情况下，如何使用它。具体的内容要求如下：8.1引言8.1.1编写目的8.1.2背景8.1.3定义8.1.4参考资料8.2用途8.2.1功能8.2.2性能精度时间特性灵活性8.2.3安全保密8.3运行环境8.3.1硬设备8.3.2支持软件8.3.3数据结构8.4使用过程8.4.1安装与初始化8.4.2输入输入数据的现实背景输入格式输入举例8.4.3输出输出数据的现实背景输出格式输出举例8.4.4文卷查询8.4.5出错处理与恢复8.4.6终端操作9操作手册操作手册的编制是为了向操作人员提供该软件每一个运行的具体过程和有关知识，包括操作方法的细节。具体的内容要求如下：9.1引言9.1.1编写目的9.1.2背景9.1.3定义9.1.2参考资料9.2软件概述9.2.1软件的结构9.2.2程序表9.2.3文卷表9.3安装与初始化9.4运行说明9.4.1运行表9.4.2运行步骤9.4.3运行1（标识符）说明运行控制操作信息输入-输出文卷输出文段输出文段的复制启动恢复过程9.4.4运行2（标识符）说明9.5非常规过程9.6远程操作10模块开发卷宗模块开发卷宗是在模块开发过程中逐步编写出来的，每完成一个模块或一级密切相关的模块的复审时编写一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果，以便于对整个模块开发工作的管理和复审，并为将来的维护提供非常有用的技术信息。具体的内容要求如下：10.1标题10.2模块开发情况表10.3功