系统概要设计说明书提交版文档格式.docx
《系统概要设计说明书提交版文档格式.docx》由会员分享,可在线阅读,更多相关《系统概要设计说明书提交版文档格式.docx(15页珍藏版)》请在冰豆网上搜索。
2011/5/11
v1.2
根据老师口述内容修改
2011/5/13
目录
1引言3
1.1编写目的3
1.2项目背景3
1.3定义3
1.4参考资料:
3
2条件与限制3
3需求规定4
4运行环境4
4.1硬件环境4
4.2软件环境4
5体系架构5
5.1系统结构5
5.2软件架构5
6逻辑结构设计5
6.1CSCI列表6
6.2CSCI关系图7
6.3CSCI-1-1话音数据记录(VoiceRecord)8
6.3.1模块名称8
6.3.2功能描述8
6.3.3接口描述8
6.3.3.1输入接口8
6.3.3.2输出接口10
6.3.4流程描述10
6.3.4.1话音记录初始化流程描述错误!
未定义书签。
6.3.4.2话音记录流程描述11
6.3.4.3XXX命令流程描述11
6.3.5补充说明11
6.4CSCI-4网络与公共基础支持(BasicPublic)错误!
6.4.1模块名称错误!
6.4.2功能描述错误!
6.4.2.1输入接口错误!
6.4.3补充说明错误!
7数据(库)结构设计11
7.1逻辑结构设计要点11
7.2物理结构设计要点12
8部署设计12
9运行设计12
9.1运行模块组合12
9.2运行控制12
9.3运行目录结构12
10性能设计12
11系统出错处理设计12
11.1出错信息12
11.2补救措施13
11.3系统维护设计13
11.4错误处理设计13
12开发环境13
13尚未解决的问题13
引言
编写目的
本系统设计说明书用于描述工作备忘录提示软件项目的整体系统设计方案,本说明书以《用户需求说明书》和《系统需求规格说明书》作为依据,本说明书是系统详细设计的依据,也作为系统测试需求和系统测试计划和测试程序的重要参考。
本系统概要设计说明书的阅读对象为:
项目经理,开发工程师,测试工程师,CM工程师,QA工程师,MA工程师。
项目背景
委托单位:
暂无。
开发单位和主管部:
本课程第五小组成员。
本项目系《研究与开发实践》课程的实验项目,目地是学习软件开发的详细
过程,获取实际编写需求分析、概要设计等开发软件的经验,为以后工作期间的开发工作打下坚实的基础。
定义
CSCI:
ComputeSoftwareConfigurationItem(计算机软件配置项)
MMI:
Man-Machineinterface(人-机界面)
参考资料:
无。
条件与限制
(1):
需求约束:
本系统应当遵循的标准或规范:
软件、硬件环境的约束:
软件:
windows95及以上windows操作系统
硬件:
包含扬声器、主机、显示器、键盘鼠标等的个人电脑。
接口/协议的约束:
用户界面的约束:
windows应用程序界面。
软件质量的约束:
(2):
隐含约束:
需求规定
●系统能根据时间发出提醒音乐声。
●系统可以创建、修改、删除事件。
●系统可以更换提醒音乐。
详细需求参见《系统需求规格说明书》
运行环境
硬件环境
硬件平台为windows95以上的带windows操作系统的个人计算机,需带扬声器。
系统需本机普通声卡支持。
软件环境
系统运行的操作系统为windows95及以上windows操作系统。
体系架构
系统结构
本系统系单机软件工作备忘录提示软件。
软件架构
本系统系单机软件仅含一台个人计算机。
逻辑结构设计
图6-1系统顶层软件结构图
如图6-1所示,系统由8个顶层软件模块组成:
●CSCI-1ControlUnitMML:
控制单元界面。
实现系统与用户的接触;
●CSCI-2MusicCharge:
系统管理单元。
实现系统内所有提示音乐的管理;
●CSCI-3ItemCharge:
实现对事件的管理;
●CSCI-4MusicPlay:
音乐播放,到点自动播放音乐;
CSCI列表
表6.1-1全系统CSCI列表
备忘录提示软件记录单元
模块名称、标识
功能简述
CSCI-1ControlUnitMML
CSCI-2MusicCharge
系统管理单元。
CSCI-3ItemCharge
CSCI-4MusicPlay
音乐播放,到点自动播放音乐;
CSCI关系图
参见图6-1。
CSCI-1控制单元界面
模块名称
控制单元界面
功能描述
实现对外部输入的事件的创立、修改、删除、显示和查找。
具体功能如下:
●根据用户输入的内容创立事件
●根据用户输入的内容对相应事件进行修改和删除。
●根据用户所选择内容对相应事件显示。
●根据用户输入内容对事件进行查找。
接口描述
输入接口
(1)输入条件
本包无其他包的输入。
(2)传递消息定义
无。
(3)传输方式
本包通过设备管理接口从外部设备输入数据。
输出接口
(1)输出条件
本包对CSCI2和CSCI3提供调用
本包通过系统内部函数实现调用。
流程描述
记录流程描述
XXX命令流程描述
补充说明
CSCI-2音乐管理
音乐管理单元
实现对提示音乐的管理。
提示音乐库中的音乐为系统事先设定,并为每项音乐设置一个数字编号;
●根据用户选择确定一项音乐为提示音乐;
本包调用CSCI1。
本包对CSCI4提供调用。
本包通过系统内部间函数实现调用。
CSCI-3事件管理
事件管理单元
根据外部对事件的创立、修改、删除在事件库中对事件实行相应的存储;
本包通过系统内部的函数调用。
CSCI-4音乐播放
自动音乐播放单元
根据系统时间与事件库中事件设置的时间自动播放音乐。
●根据音乐设置修改自动播放音乐中的音乐;
●根据事件库中事件到点自动播放音乐;
本包调用CSCI2和CSCI3。
本包通过系统内部之间的函数调用输入数据。
本包不对其他包提供调用。
本包通过设备管理接口输出到外部设备的数据。
数据(库)结构设计
逻辑结构设计要点
物理结构设计要点
部署设计
本系统仅需一台个人计算机。
运行设计
运行模块组合
[描述对系统施加不同的外界运行控制时所引起的各种不同的运行模块组合,说明每种运行所历经的内部模块和支持软件。
]
运行控制
[描述每一种外界的运行控制的方式方法和操作步骤。
运行目录结构
所有执行文件、日志文件都存放在一个目录。
性能设计
系统出错处理设计
出错信息
1.输入的事件长度超过系统规定的长度时,将会使事件不能成功创建;
2.在查找事件时,若事件库中不存在该事件,在会显示出错信息;
3.系统不能正常播放音乐;
补救措施
针对3,用户可以选择另一提示音乐;
系统维护设计
[描述为了系统维护的方便而在程序内部设计中作出的安排,包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。
如:
内部调试信息,rdp记录的数据文件,远程维护等。
错误处理设计
以窗口形式弹出错误提示;
开发环境
[列出以下内容,并作出概要的说明:
编辑器、编译环境、配置管理工具;
源代码的目录结构等。
尚未解决的问题
[列出系统中尚未解决的,暂未考虑的,今后可能扩展的问题的描述和可能采取的解决方案。
现无同步的话音、雷达离线工具;
未定义的外部接口等。