面向过程软件需求规约——例子.doc

论坛回复监控小助手软件需求规约论坛回复监控小助手软件需求规约 Bulletin Board System Assistant Software Requirements Specification 项目名称项目名称 论坛回复监控小助手 摘要摘要 本文档系统阐述软件 论坛回复监控小助手 的详细信息 本文档主要介 绍 论坛回复监控小助手 在开发过程中的具体需求 以及设计约束条件 作为 将来项目设计 测试和验收的标准 相关文档相关文档 修改记录 修改记录 日期日期版本版本说明说明作者作者 2009 9 20V1 0分析该项目 建立完整的信息描述 详 细的功能和行为描述 性能需求和设计 约束的说明 合适的验收标准 给出 该软件的各种需求 2009 9 27V1 1重新组织文件框架 增添数据字典 增添用 例模型 增添功能实现方法 修改前言部分 修改约束条件 2009 10 13V1 2缩减设计与假设关系 完善用例模型调查 2009 10 17V1 3修改目录 完善数据字典 完善用例模型调 查 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 2 页 目目 录录 1简介简介 4 1 1目的 4 1 2范围 4 1 3定义 首字母缩写词和缩略语 5 1 4参考资料 5 1 5概述 5 2整体说明整体说明 6 2 1用例模型调查 6 2 2假设与依赖关系 11 3具体需求具体需求 12 3 1用例报告 12 3 2补充需求 12 3 3数据字典 13 3 3 1设置监控论坛 13 3 3 2选择实时监控论坛 13 3 3 3查看信息 14 3 3 4登录验证 16 3 3 5结构层次图 17 4设计约束设计约束 17 4 1实现平台约束 17 4 2技术实现约束 18 4 3程序注释约束 18 4 4文档模版约束 18 4 5软件文档编写约束 18 4 6时间约束 18 5交付技术内容交付技术内容 18 6时间安排时间安排 18 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 3 页 1 简介简介 论坛回复监控小助手软件需求规约 主要是描述基于 Windows 平台开发的一个自动跟 踪监控论坛上所发帖子的回复情况的软件完整需求 其主要目的为对 论坛回复监控小助手 软件进行定义 详尽说明该软件的需求 阐述开发者对软件 论坛回复监控小助手 的初步设 想 并划分的各功能模块等以及各模块的实体图等 论坛回复监控小助手软件需求规约 在整个项目开发阶段中控制系统的演进 在 前景 文档中添加新特性或修改特性的同时 将在 论坛回复监控小助手软件需求规约 中详细说明 这些特性 下列人员使用软件需求规约 1 系统分析员创建并维护前景和补充规约 它们将用作对 论坛回复监控小助手软 件需求规约 的输入 并充当系统分析员 客户和其他开发人员之间的交流媒介 2 用例阐释者创建并维护单个用例和 论坛回复监控小助手软件需求规约 的其他 构件 设计员在定义类的职责 操作和属性时 或在调整类使其适应实施环境时 参考该 论坛回复监控小助手软件需求规约 3 实施员实施类时在 论坛回复监控小助手软件需求规约 中查找输入 4 项目经理计划迭代时在 论坛回复监控小助手软件需求规约 中查找输入 5 测试员使用 论坛回复监控小助手软件需求规约 来核实系统的一致性 1 1 目的目的 论坛回复监控小助手软件需求规约 主要目的为收集与组织所有与 论坛回复监控小助 手 有关的需求 我们希望通过 论坛回复监控小助手软件需求规约 来说明 论坛回复监 控小助手 各项特性 其中包括几个来自系统用例模型中的用例 以此来说明此特性的功能性 需求 以及补充规约中一系列相关的详细需求 1 2 范围范围 本文档主要涉 论坛回复监控小助手 要求和设计约束 以及通信组件和检查组件的开发 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 4 页 内容和验证方式 1 3 定义 首字母缩写词和缩略语定义 首字母缩写词和缩略语 BBSA Bulletin Board System Assistant 电子公告板系统助手 以下简称 BBSA SRS Software Requirements Specification 软件需求规约 以下简称 SRS 1 4 参考资料参考资料 书名 文档作者出版社出版日期 软件工程王庆育 编著 清华大学出版社2004 年 7 月 软件工程任胜兵 邢琳编北京邮电出版社2004 年 5 月 软件工程张海潘 编著 人民邮电出版社2006 年 1 月 UML 基础与 Rose 建模实用教程谢星星 沈懿卓清华大学出版社2008 年 10 月 UML 基础与 Rose 建模教程蔡敏 徐慧慧 黄炳强编著 人民邮电出版社2006 年 1 月 1 5 概述概述 随着信息时代的到来 人们的时间越来越宝贵 互联网上为我们提供了无数热心而又能力 各异的老师 我们可以通过各大相关论坛处提出我们专业或非专业的提问 以解决我们正面对的 问题或满足我们的好奇心 但是如果问题过多或所涉及的论坛数过多 频繁地人工去查看相关论 坛的提问有没有被回复和我们的回答是否被采纳 是一件效率低下而且无意义的工作 我们推出的软件 论坛回复监控小助手 BBSA 就可以很好地帮助用户完成上面工作 用户只需要在我们软件上设置好需要监控的论坛和对应的账号密码 我们就可以为用户在 后台动态地监控该账号所未关闭的问题有没有被回复 或我们的回答是否被采纳成最佳答案 我们的软件可以为用户提供监控多论坛 多账号的功能 是所有 爱问之人 所钟爱的产品 登 陆各账号时有少许繁琐 需要我们用户为每个账户登录时输入论坛的验证码 这是互联网的安全 保证 我们必须遵守 当用户在 BBSA 中输入了希望关心的论坛和对应账号密码后 BBSA 就在后台工作 并以一 个用户可调的刷新周期去检测相关论坛是否更新了 若有更新 就在桌面的右下角弹出对话框 告诉用户 若无更新 则安静地在后台监控 用户也可设置将更新提示信息存放到一个文档中 由用 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 5 页 户自己手动打开查看 监控用户所输入所有论坛对应账号是否有信息更新 适用于当今绝大部分主流论坛 2 整体说明整体说明 2 1 用例模型调查用例模型调查 我们可以在网上找到一个名为 的论坛监控助手 其应用软件界面如下 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 6 页 具有监控多多社区 一 BBS 论坛 上面出现新话题的功能 支持监控所有 版块或监控特定版块 可以让用户手动设置监控的刷新周期 并且双击标题即自动打开浏览器可 进入该帖子 而且可以显示最后回复 帖子作者和发帖时间 支持手动刷新版块和停止刷新 该软件的优点是非常简洁易用 占用资源少 缺点是只能监控多多社区 不能监控其他论坛 而 且没有登录功能 不能支持查看账号下发布的帖子是否有新回复 在网上我们也可以找到 的论坛自动回复软件 其界面如下 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 7 页 适合论坛程序 Discuz 6 0 7 0 版本 登录和回复无需验 证的论坛 只要如上设置好配置 就可以自动地为用户回复帖子 该软件拥有自动登录功能 较为理想的顶贴配置功能 不过登录成功率较低 而且现今大多 数论坛均登录均需要验证码 所以导致其适用范围极大地减小 而且目标版块和目标帖子的匹配 成率也非常低 难以应用于实际 在网上我们还可以找到一个论坛挂机小助手 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 8 页 其操作界面非常简单 功能就是在输入的论坛地址里面以一定时间 刷新时间 来刷新 达到长时间在线的目的 最多支持 10 个论坛同时在线 其登录操作需要手动完成 如果 cookies 当中有该论坛的登录记录 则可以省略登录操 作 论坛挂机小助手 功能非常简单 操作简易 不过只支持刷新功能 如果目标论坛规 定一段时间没有点击操作的话就强迫退出登录的话 该软件将不适用 该软件不能自动登录 不能监控用户下的信息 功能过于单一 我们推出的软件 除了能实现上面三个软件的功能外 还有实 现我们的核心功能 监控我们用户所发的帖子是否被回复了 或我们的回答是否被采纳成最佳答 案 界面如下 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 9 页 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 10 页 论坛回复监控小助手 不像 多多助手 V1 0 只能监控某一特定论坛 我们能监控多论 坛 多板块 而 多多助手 V1 0 的手动设置刷新周期和双击标题即可自动打开浏览器进入帖 子的功能我们会继续沿用 discuz7 顶贴小助手 V1 1 只适合论坛程序 Discuz 6 0 7 0 版本 登录和回复无需验证的论坛 而我们的 论坛回复监控小助手 可以支持 Discuz 6 0 7 0 版本 登录需验证的论坛 但我们的 论坛回复监控小助手 不支持回复功能 论坛 挂机小助手 功能过于单一 不能满足日益增长的用户需求 综上所述 较于上述三个现时比较流行的论坛助手 我们的 论坛回复监控小助手 更为 人性化 更为强大 而且我们的核心功能 监控用户的帖子是否被回复或采纳 是现时的软 件都没有的 这是我们的核心优势和市场竞争力 2 2 假设与依赖关系假设与依赖关系 基于以下的理由 选择 JAVA php 作为我们的开发起点 2 2 1 登陆脚本 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 11 页 设置好各论坛登陆框 使所输入的用户名和密码对应在用户所登陆的网站论坛等 某些论 坛可能还需要输入验证码才可以登陆 我们所要实现的软件也应该具备能获取验证码的功能 如与该论坛上的验证码同步 在源文件中可以找到 即能捕获得到该论坛上的验证码 使用户 登陆成功 2 2 2 后台工作脚本 刷新与检测更新脚本 登陆成功后 软件能稳定地在后台运行工作 对用户所设定监控的论坛具备有检测 捕获 更新信息的功能 本软件采用记录回复数的方式返回显示出来 设置好每隔一段时间刷新并检 测 如果检测到回复数与上次刷新时的回复数不一致 则判断为有更新 3 具体需求具体需求 3 1 用例报告用例报告 首次安装 BBSA 后 便弹出一对话框让用户设置希望监控的论坛和对应的账号密码 设置完 毕之后就弹出当前希望关心的论坛 也就是从刚刚设置的论坛中选择一部分来监控 此也为以后 开启 BBSA 时显示的页面 选择好监控论坛后 BBSA 就进入后台工作状态 并以一定的刷新频率 去检测用户关心的论坛 当有更新时就在桌面的右下角弹出提示对话框告诉用户哪些论坛的哪 些帖子被回复 或用户哪些回复被采纳了 用户也可设置不显示提示 而将提示信息存放在一个文 档中供用户手动查看 现在主流的大论坛我们都可以利用 cookie 帮助我们的登录 以实现输入一次验证码 以后长 时间里都不用再输入验证码 有些论坛即使我们刷新了 但没其他操作时 则会被迫退出登录 若我 们检测到这种情况 我们就会在软件内部标志其为特殊的论坛 除了按刷新周期去刷新外 还会按 刷新周期去点击一些页面 而且这些页面不会回显给用户 以达到不退出登录的目的 3 2 补充需求补充需求 本软件还可支持以搜索关键字的形式去监控论坛上面的新帖子 以方便用户时刻关注论坛 上对用户有用的信息 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 12 页 3 3 数据字典数据字典 3 3 1 设置监控论坛设置监控论坛 1 1 安装成功后 软件会自动弹出一个对话框要求用户设置需要监控的论坛 用户在使用 过程中若要添加监控论坛可点击软件菜单栏 设置监控论坛 标签进行设置 1 2 标签 论坛名 下的文本框添加由字母 数字或汉字组成的 4 20 个字节的论坛名称 1 3 标签 论坛名 下的文本框添加由字母和 等特殊符号或者阿 拉伯数字组成组成的 4 50 个字节的网址 1 4 标签 用户 下的文本框添加由英文字符或者汉字 下划线等组成的 4 20 个字节的 用户名 1 5 标签 密码 下的文本框添加由英文字符或者阿拉伯数字等组成的 6 20 个字节的密 码 从安全角度考虑 用户在正确输入密码后 该文本框均用 6 个 来回显用户输 入的字符 1 6 点击页面右下方 添加 命令按钮来添加需监控论坛的信息 输入规则遵循 1 2 1 3 1 4 1 5 1 7 点击页面右下方 编辑 命令按钮来修改已设置监控论坛的信息 输入规则遵循 1 2 1 3 1 4 1 5 1 8 点击页面右下方 删除 命令按钮删除已设置的论坛 若用户不需实时监控某个论坛 也可通过勾选实时监控论坛的列表来实现 详情见 2 选择实时监控论坛 3 3 2 选择实时监控论坛选择实时监控论坛 2 1 点击软件菜单栏 选择实时监控论坛 标签设置用户所需实时监控的论坛 2 2 选择实时监控论坛 的主页面关联显示用户已设置需要监控的论坛名称 设置监控 论坛详见 1 设置监控论坛 2 3 点击在 选择实时监控论坛 的主页面所显示的论坛名称前面的小方框可选择或者取 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 13 页 消选择需要实时监控的论坛 2 4 点击页面右下方 添加 命令按钮来添加实时监控论坛的名称 此时软件弹出新的对 话框链接到 设置监控论坛 页面 遵循 1 如何设置监控论坛 中的原则添加论坛 相关信息 完成该操作后在 选择实时监控论坛 的主页面可所添加的论坛名称 选 择或者取消选择操作遵循 2 3 2 5 点击页面右下方 确定 命令按钮来确认实时监控论坛的名称 2 6 点击页面右下方 取消 命令按钮来取消本次选择实时监控论的操作 3 3 3 查看信息查看信息 3 1 点击软件菜单栏 查看更新信息 标签查看所监控论坛的更新信息 3 2 查看更新信息 主页面以显示 你在 发表的 帖子已有回复 请点击查看 字样的形式提示所监控论坛已有更新的信息 3 3 点击 请点击查看 来查看信息详情 3 4 显示更新信息情况下的对话框为输入文本框 3 5 在输入文本框编辑文本 点击 回复 按钮可直接对帖子进行回复 3 6 在输入文本框编辑文本 点击 发帖 按钮可在查看信息的相应论坛发新的帖 3 7 查看更新信息 主页面左侧为最近访问论坛的列表 点击相应链接 用户可在输入 文本框编辑文本 选择 回复 或 发帖 命令按钮在关联论坛进行相应回复或者发 帖的操作 3 8 启动软件时 右击工具栏软件图标 选择设置实时显示信息 点击列表中的 实时显 示信息 选项前的单选框 选择或取消选择实时显示信息 3 9 在 实时显示信息 模式下 信息以弹出对话框形式 主页面以显示 你在 发表 的 帖子已有回复 请点击查看 字样的形式提示所监控论坛已有更新的信息 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 14 页 3 10 若不在 实时显示信息 模式下 则需要用户手动点击进入主界面查看更新提示信 息 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 15 页 3 3 4 登录验证登录验证 4 1 每次启动软件登录论坛时 系统弹出 登录验证 对话框 4 2 登录验证 对话框将以文本形式 你好 你正在登录 请输入验证码 提示 用户正在登录的论坛以及要求用户输入验证码 4 3 登录验证 对话框以文本形式显示用户登陆前所设定的不同论坛下的用户名以及 密码 其中 无论实际密码的长度为多少 均以 6 个 回显 4 4 用户需在 登录验证 对话框中的 验证码 右面的对话框输入验证码 其中验证 码根据各论坛的不同会有数字 英文字母 汉字的不同组合 用户根据图片所显示的验证码输 入 4 5 当用户看不清当前验证码时 可点击 换一张 任务项更换验证码 4 6 点击 登录 按钮登录相应论坛 论坛回复监控小助手 软件需求规约 用于Software Requirements Specification 深圳大学计算机与软件学院 第 16 页 3 3 5 结构层次图结构层次图 论坛回复监控小助 手 进入界面 2 0 登陆 1 0 对应的账号密码 1 2 设置当前希望 关心的论坛 1 3 设置希望监控的论 坛 1 1 保存帐号和密码 1 2 1 选择实时监控 论坛 2 2 查看更新消息 2 3 设置监控论坛 2 1 帮助 2 4 使用说明 2 4 1 联系我们 2 4 2 显示 2 3 1 搜索 2 3 2 双击查看 2 3 3 后台工作 3 0 提示消息 3 1 不再提示 3 2 4 设计约束设计约束 在 论坛回复监控小助手 程序的设计过程中 除了保证 论坛回复监控小助手 的可用 性以外 系统的低资源占用 以及稳定性也是必须考虑的问题