《软件工程实验功能设计说明书.doc》由会员分享,可在线阅读,更多相关《软件工程实验功能设计说明书.doc(16页珍藏版)》请在taowenge.com淘文阁网|工程机械CAD图纸|机械工程制图|CAD装配图下载|SolidWorks_CaTia_CAD_UG_PROE_设计图分享下载上搜索。
1、文件类型编号小学生试题自动生成软件功能设计说明书文件编号:编写部门:西工大啊大宝小组成员:董晓东孙宇欣李曦舟杜凡编写日期:2012.5.22西北工业大学软件工程演习改版履历:改版履历文件名:啊哒宝小学生题目自动生成软件制定部门:西北工业大学啊哒宝小组版数承认/日期查阅/日期编写者/日期改版内容1.0.02012.5.22啊大宝小组无以下虚线部分为说明内容.如果删除虚线部分, 可以作为说明书框架使用.封面:功能名称: 啊哒宝小学生算术试题自动生成工具版本号: 描述本设计书的版本号. 编写日期:本说明书发布日期编写部门: 啊哒宝小组编写者: 本说明书编写/发布者改版履历:记录版本的修改历史.进行改
2、版时, 要记录版本号, 改版内容, 改版后的查阅、承认者和查阅、承认日期, 改版者和改版日期(即作成者和作成日期)改版内容需要记录修改场所, 内容和理由.设计输入说明书:记述用于做成本说明的输入说明书. 功能设计说明书的输入说明书通常是需求设计说明书.以下的记述项目可以根据实际的开发内容进行追加, 修正.目录 页号1引言11.1目的11.2文档约定11.3预期的读者和阅读建议11.4产品的范围11.5参考文献22综合描述22.1产品的前景22.2产品的功能22.3用户类和特征22.4运行环境22.5设计和实现上的限制32.6假设32.7对其它Component的影响33信息描述43.1信息内容
3、43.2信息流表示4数据流4控制流44功能44.1功能划分44.2功能1描述4功能处理说明4制限事项4支撑图44.3功能2描述4功能处理说明4制限事项4支撑图45行为描述55.1系统状态55.2事件和动作56外部接口56.1命令行56.2Message66.3画面/GUI66.4软件接口76.5通信接口76.6宏/API77使用和操作方法87.1环境设定87.2使用方法87.3操作方法88系统结构和实现方法98.1系统结构98.2实现方法98.3实现环境99其他非功能需求109.1性能需求109.2安全设施需求109.3安全性需求109.4软件质量属性109.5业务规则119.6用户文档111
4、0补充事项1110.1关于兼容性1110.2相关资料1110.3术语说明1111功能测试项目1112附录A 词汇表1213附录B 分析模型1214待确定问题的列表1215编写需求文档的原则141 引言1.1 目的啊哒宝小学生算术试题自动生成工具V1.3是本产品的稳定发行版本,可供用户方便使用。本产品是一款可供1-6年级小学生进行算术试题训练的工具,本工具旨在减轻家长辅导负担,增强学生自学能力。本文档标题采用一号,宋体,加粗字。正文除各种标题外均采用五号,宋体字,单倍行距。各待修改文件的优先级按选取时间依次降低。1.2 文档约定预期读者:开发项目组,委托方阅读建议:目录查找1.3 预期的读者和阅
5、读建议1.4 产品的范围减轻小学教师负担,提升小学生自学能力市面上电子教辅甚少,所以开发本项目的市场前景优良制定本软的目的:一、方便用户修改文件属性;二、提高自己的编程和写作能力;三、加深对软件工程的了解目标:在GUI环境下实现文件属性的修改。软件工程导论 清华大学出版社 张海藩 编著软件工程基础教程 北京大学出版社刘文、朱飞雪 主编Java核心技术机械工业出版社Gary Cornell百度CSDN豆丁1.5 参考文献2 综合描述2.1 产品的前景提供小学生试题自动生成功能。本产品是啊哒宝小学生算术试题自动生成工具系列的成员,是成熟产品所改进的下一代产品,是现有应用程序的替代品。2.2 产品的
6、功能本产品具有小学生试题按年级分类,练习,测试,评分功能。2.3 用户类和特征小学生家庭,小学教师。2.4 运行环境HW:CPU - Intel(R) Pentium(R) 4 内存 512MSW:Java EclipseOS:Windows XP/2000/VISTA/WIN7 2.5 假设没有使用允许的操作系统。个别杀毒软件的报错处理。仅当GUI改变时会对程序模块产生影响。2.6 对其它Component的影响3 信息描述3.1 信息内容用户输入的年级,用户输入的题目数量,用户根据题目输入的答案,用户输入的答案的结果正确与否。3.2 信息流表示数据流用户主界面二级界面题目输出判断题目提示错
7、误兵给出正确答案提示正确打开程序选择年级输入题目数量接受用户输入答案答案正确答案错误4 功能详细描述开发的功能不仅要用文字描述, 还应该用易于理解的图说明.4.1 功能划分1. 试题年计划分2. 根据用户的年级确定题目的难易程度,在用户输入题目数量以后输出相应年级的题目(每次输出一个),用户可以根据个人原因选择做大或者跳过。3. 判题系统根据题目相应的答案和用户输入的答案进行判题。给出正确答案。4.2 功能描述功能处理说明根据用户选择,生成对应年级的试题。根据用户输入的题目数量逐一生成对应数量的题目。判断题目正确并出正确答案。制限事项年级必须选择并在1-6之间,题目最大数量不大于100最少为1
8、.支撑图 小学生题目生成并判题功能题目生成功能模块判题功能模块输入输出模块生成题目题目判断用户输入系统输出5 行为描述5.1 系统状态选择年级输入题目数量生成题目判题输出结果退出5.2 事件和动作主界面,二级界面,题目生成,判题,系统输出,帮助信息,退出,返回。6 外部接口6.1 命令行无6.2 Message 至少记述以下内容 Message的输出场所(stdout, stderr, syslog,Eventlog, 自己的log等) Message形式 Message的含义Message可以变化部分的说明。 必要的处理如果是输入错误,则重新修改或输入参数;.如果是硬件故障, 则应根据具体情
9、况查明相应故障部件,并及时排除故障或者更换硬件。. 6.3 画面/GUI主界面:年级选项,退出按钮。二级界面:题目数量输入。出错界面:提示用户操作出现错误。主类和各个子类一级界面的MyFrame类,二级界面的YourFrame类 弹出窗口的outr和outw类,和这些类所调用的Panel类。读题的Question类,读答案的result类。对文档数据库进行读取的QuestionWrite类。6.4 软件接口6.5 宏/API按照UNIX的Online Manual的项目来描述.名称语法 参数说明除了基本信息说明以外, 还需要明确记述以下内容. 输入/输出参数.不能同时使用的参数组合 . 最大值
10、, 最小值 . 不正确或无效的参数值 . 特殊时序使用的结果例1 有相反作用的API同时执行时例2 高负荷状态时执行的情况.返回值描述所有可能返回的值的含义. 例子警告例1在多线程程序中调用时需要注意的内容例2 内部需要内存等资源的函数,资源分配后FORK子进程时的使用方法. 参考相关命令和API.7 使用和操作方法 7.1 环境设定使用Windows XP及以上版本的操作系统,非涉密PC,其他环境均采用默认值。7.2 使用方法在Windows XP及以上版本的操作系统中,双击啊大宝.exe可执行程序,打开本软件,进入操作界面。若出现杀毒软件报错情况,请更换/卸载或者暂时关闭或休眠杀毒软件,进
11、入到操作界面后,即可进行操作,使用完毕后可点击退出或者关闭来退出本软件。如遇到软件故障可关闭或退出本软件然后重新启动本软件。7.3 操作方法使用鼠标,在功能界面上选择用户想要使用的功能按钮进行操作,在点击功能按钮后等待片刻即可完成操作,如欲进行其他操作,可继续进行。8 系统结构和实现方法8.1 系统结构 主程序与主图形界面判题模块题目生成模块输入输出模块8.2 实现方法数据库内容同图形界面的结合以及图形界面的美化和优化是本次软件开发的重难点。8.3 实现环境软硬件环境:HW:CPU - Intel(R) Pentium(R) 4 内存 512MSW:Visual C+ 2005OS:Windo
12、ws XP/2000/VISTA/WIN7 开发语言:Java开发工具:eclipse 3.7.29 其他非功能需求9.1 性能需求在运行微软Windows 2000的450MHzPentiumII及以上配置的计算机上,当系统至少有10%的空闲资源时,95%的单题生成必须在两秒内完成。9.2 安全设施需求严禁处理涉密文件,一切本软件的非正当使用所造成的破坏或危害由用户自己承担责任。在使用本软件操作文件时请预先备份文件。如果本软件出现了停止工作或选取的文件超过最大数量限制时,请停止操作。仅本机用户可使用该软件。9.3 安全性需求本软件易于操作,易学性好,具有较好的可移植性。9.4 软件质量属性只
13、有具有管理员权限的用户才能对本软件进行修改。9.5 业务规则帮助信息界面9.6 用户文档10 补充事项10.1 关于兼容性Windows 98及以上版本均可。.10.2 相关资料软件工程导论 清华大学出版社 张海藩 编著软件工程基础教程 北京大学出版社刘文、朱飞雪 主编Java核心技术机械工业出版社Gary Cornell百度CSDN豆丁11 功能测试项目模块工作效率,软件可靠度,程序是否容易崩溃。12 附录A 词汇表CSDN:互联网一著名IT网站GUI:图形用户界面API:应用程序接口13 待确定问题的列表 !编辑一张在软件需求说明中待确定问题的列表,其中每一表项都是编上号的,以便跟踪调查。
14、保护页编写需求文档的原则 保持语句和段落的简短。 采用主动语态的表达方式。 编写具有正确的语法,拼写和标点的完整句子。 使用的术语与词汇表中所定义的应该一致。 需求陈述应该具有一致的样式,例如“系统必须。”或者“用户必须。”,并紧跟一个行为动作和可观察的结果。例如,“仓库管理子系统必须显示一张所请求的仓库中有存货的化学药品容器清单” 为了减少不确定性,必须避免模糊的,主观的术语,例如用户友好,容易,简单,迅速,有效,支持,许多,最新技术,优越的,可接受的和健壮的。 避免使用比较性的词汇,例如:提高,最大化,最小化和最佳化。定量地说明所需要提高的程度或者说清一些参数可接受的最大值和最小值。 控制详细程度。如果你想出一些相关的测试用例可以验证这个需求能够正确地实现,那么就达到了合理的详细程度。 不要把多个需求集中在一个冗长的叙述段落中。 不应出现需求冗余。使用交叉引用。