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
3、.6 假设 32.7 对其它Component的影响 33 信息描述 43.1 信息内容 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.2 Message 66.3 画面/GUI 66.4 软件接口 76.5 通信接口 76.6 宏/API 77 使用和操作方法 87.1 环境设定 87.2 使用方法 87.3 操作方法 88 系统结构和实现方法 98
4、.1 系统结构 98.2 实现方法 98.3 实现环境 99 其他非功能需求 109.1 性能需求 109.2 安全设施需求 109.3 安全性需求 109.4 软件质量属性 109.5 业务规则 119.6 用户文档 1110 补充事项 1110.1 关于兼容性 1110.2 相关资料 1110.3 术语说明 1111 功能测试项目 1112 附录A 词汇表 1213 附录B 分析模型 1214 待确定问题的列表 1215 编写需求文档的原则 141 引言1.1 目的啊哒宝小学生算术试题自动生成工具V1.3是本产品的稳定发行版本，可供用户方便使用。本产品是一款可供1-6年级小学生进行算术试题
5、训练的工具，本工具旨在减轻家长辅导负担，增强学生自学能力。1.2 本文档标题采用一号，宋体，加粗字。正文除各种标题外均采用五号，宋体字，单倍行距。各待修改文件的优先级按选取时间依次降低。文档约定1.3 预期读者：开发项目组，委托方阅读建议：目录查找预期的读者和阅读建议1.4 产品的范围减轻小学教师负担，提升小学生自学能力市面上电子教辅甚少，所以开发本项目的市场前景优良制定本软的目的：一、方便用户修改文件属性；二、提高自己的编程和写作能力；三、加深对软件工程的了解目标：在GUI环境下实现文件属性的修改。1.5 软件工程导论 清华大学出版社 张海藩 编著软件工程基础教程 北京大学出版社 刘文、朱飞
6、雪 主编Java核心技术 机械工业出版社 Gary CornellXXCSDN豆丁参考文献2 综合描述2.1 产品的前景提供小学生试题自动生成功能。本产品是啊哒宝小学生算术试题自动生成工具系列的成员，是成熟产品所改进的下一代产品，是现有应用程序的替代品。2.2 产品的功能本产品具有小学生试题按年级分类，练习，测试，评分功能。2.3 用户类和特征小学生家庭，小学教师。2.4 运行环境HW:CPU - Intel(R) Pentium(R) 4 内存 512MSW:Java EclipseOS:Windows XP/2000/VISTA/WIN7 2.5 假设没有使用允许的操作系统。个别杀毒软件的
7、报错处理。2.6 仅当GUI改变时会对程序模块产生影响。对其它Component的影响3 信息描述3.1 信息内容用户输入的年级，用户输入的题目数量，用户根据题目输入的答案，用户输入的答案的结果正确与否。3.2 信息流表示数据流4 功能详细描述开发的功能不仅要用文字描述, 还应该用易于理解的图说明.4.1 功能划分1. 试题年计划分2. 根据用户的年级确定题目的难易程度，在用户输入题目数量以后输出相应年级的题目（每次输出一个），用户可以根据个人原因选择做大或者跳过。3. 判题系统根据题目相应的答案和用户输入的答案进行判题。给出正确答案。4.2 功能描述功能处理说明 根据用户选择，生成对应年级的
8、试题。根据用户输入的题目数量逐一生成对应数量的题目。判断题目正确并出正确答案。制限事项 年级必须选择并在1-6之间，题目最大数量不大于100最少为1.支撑图 5 行为描述5.1 系统状态5.2 事件和动作主界面，二级界面，题目生成，判题，系统输出，帮助信息，退出，返回。6 外部接口6.1 命令行无6.2 Message 至少记述以下内容 Message的输出场所(stdout, stderr, syslog,Eventlog, 自己的log等) Message形式 Message的含义Message可以变化部分的说明。 必要的处理如果是输入错误,则重新修改或输入参数；.如果是硬件故障, 则应根
9、据具体情况查明相应故障部件，并及时排除故障或者更换硬件。. 6.3 画面/GUI主界面：年级选项，退出按钮。二级界面：题目数量输入。出错界面：提示用户操作出现错误。6.4 主类和各个子类一级界面的MyFrame类，二级界面的YourFrame类 弹出窗口的outr和outw类，和这些类所调用的Panel类。读题的Question类，读答案的result类。对文档数据库进行读取的QuestionWrite类。软件接口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 实现环境9 其他非功能需求9.1 性能需求在运行微软Windows 2000的450MHzPentiumII及以上配置的计算机上，当系统至少有10%的空闲资源时，95%的单题生成必须在两秒内完成。9.2 安全设施需求严禁处理涉密文件，一切本软件的非正当使用所造成
12、的破坏或危害由用户自己承担责任。在使用本软件操作文件时请预先备份文件。如果本软件出现了停止工作或选取的文件超过最大数量限制时，请停止操作。9.3 仅本机用户可使用该软件。安全性需求9.4 本软件易于操作，易学性好，具有较好的可移植性。软件质量属性9.5 只有具有管理员权限的用户才能对本软件进行修改。业务规则9.6 帮助信息界面用户文档10 补充事项10.1 关于兼容性Windows 98及以上版本均可。.10.2 相关资料软件工程导论 清华大学出版社 张海藩 编著软件工程基础教程 北京大学出版社 刘文、朱飞雪 主编Java核心技术 机械工业出版社 Gary CornellXXCSDN豆丁11
13、功能测试项目模块工作效率，软件可靠度，程序是否容易崩溃。12 附录A 词汇表CSDN:互联网一著名IT网站GUI：图形用户界面API：应用程序接口13 待确定问题的列表 ！编辑一张在软件需求说明中待确定问题的列表，其中每一表项都是编上号的，以便跟踪调查。 保护页编写需求文档的原则 保持语句和段落的简短。 采用主动语态的表达方式。 编写具有正确的语法，拼写和标点的完整句子。 使用的术语与词汇表中所定义的应该一致。 需求陈述应该具有一致的样式，例如“系统必须。”或者“用户必须。”，并紧跟一个行为动作和可观察的结果。例如，“仓库管理子系统必须显示一张所请求的仓库中有存货的化学药品容器清单” 为了减少不确定性，必须避免模糊的，主观的术语，例如用户友好，容易，简单，迅速，有效，支持，许多，最新技术，优越的，可接受的和健壮的。 避免使用比较性的词汇，例如：提高，最大化，最小化和最佳化。定量地说明所需要提高的程度或者说清一些参数可接受的最大值和最小值。 控制详细程度。如果你想出一些相关的测试用例可以验证这个需求能够正确地实现，那么就达到了合理的详细程度。 不要把多个需求集中在一个冗长的叙述段落中。 不应出现需求冗余。使用交叉引用。
