详细设计说明书实例.doc

山东商业职业技术学院 SF宠物精灵史努比 软件开发文档

SF宠物精灵史努比
(详细设计说明书)

编写单位：
山东商业职业技术学院SF软件设计团队
设计人员：
林波、石洪波、徐晓娜、孟文静、孙新志
版 本：
1.0
编写日期：
2006.8

目录
第一部分、引言 2
1.1编写目的 2
1.2背景 2
1.3定义 2
3.1程序描述 4
3.2功能 4
3.3性能 5
3.4输人项 5
3.5输出项 5
3.6算法 5
3.7流程逻辑 5
3.9存储分配 6
3.10注释设计 6
3.11限制条件 6
3.12测试计划 6
3.13尚未解决的问题 7
4.1 程序描述 7
4.2 功能 7
4.3 性能 7
4.4 输入项 7
4.5 输出项 7
4.6 算法 7
4.7 逻辑流程 7
4.8 接口 8
4.9 存储分配 8
4.10 注释设计 8
4.11 限制条件 8
4.12 测试计划 9
4.13 尚未解决的问题 9
5.1 定时提醒 9
5.1.1 描述 9
5.1.2 功能 9
5.1.3 性能 9
5.2 屏幕保护 9
5.2.1 描述 9
5.2.2 功能 9
5.2.3 性能 9
5. 3 翻译 10
5.3.1描述 一个简单的单词翻译附加功能。 10
5.3.2 功能 10
5.3.3 性能 10
5.4 帮助系统 10
第五部分、项目分工 10

第一部分、引言
1.1编写目的
本说明书在概要设计的基础上，对精灵史奴比的各模块、程序、子系统分别进行了实现层面上的要求和说明。
软件开发小组的产品实现成员应该阅读和参考本说明进行代码的编写、测试。
1.2背景
说明：
A、 软件系统的名称:SF宠物狗软件：
B、 任务提出者：齐鲁大学生软件与外语大赛
开发者：山东商业职业技术学院 SF软件开发团队
C、 实现完成的系统将可用在所有装有Microsoft Windows 操作系统的个人PC上.为使用者提供一种全新的娱乐方式,用户在工作疲劳时可以放松自己的精神.提高自己的工作效率.
D、 本系统将是独立的系统。
1.3定义
API函数----由函数、消息、数据结构、数据类型以及语句组成，它们可在创建在 Microsoft Windows 下运行的应用程序中使用。API 中使用最多的部分是从 Windows 中调用 API 函数的代码元素，包括过程声明（Windows 函数）、用户自定义类型的定义（用来传递到函数中的数据结构），以及常数声明（传递给函数以及从函数中返回的值）。1.4参考资料
相关的文件包括：
A、 《SF 精灵狗软件项目需求说明》；
B、 《SF 精灵狗软件项目开发计划》；
C、 《SF 精灵狗软件项目概要设计》；
参考资料：
A、 新世纪开发产品《Visual Basic程序设计》
B、 互联网上的相关必需资料；
C、 国家标准《软件需求说明书》
（说明：不同的文档都有第一部分类似的引言部分，这样是为了文档能够在独立使用的时候，能够提供足够的背景信息。）
第二部分、程序系统的结构
在概要设计中，系统的在结构描述纵向上划分为二个层次，实现该系统的策略和描述请参考 详细设计文档。
系统采用Visual Basic 6.0的标准EXE工程来进行开发，实现标准包括：
1、主程序
A、工程类型：标准EXE；
B、工程名称：MultifunctionPlayer
C、编译生成文件：MultifunctionPlayer.EXE
D、引用的组件：SpeechSDK51.exe、SpeechSDK51LanPack.exe、Spchapi.exe、Mstts.exe、MsAgent.exe、tv_enua.exe
E、引用的控件：
Microsoft Agent Control 2.0 ——精灵控件；
Microsoft Windows Comman Controls 6.0 SP6 ——Windows通用组件SP6；
Microsoft Common Dialog Control 6.0 (SP6) ——共用对话框组件；
Microsoft Multimedia Control 6.0 ——MMC媒体控件
注：以上提供的是组件集合，具体用到的控件都包含在里面
2、用户自定义控件：
curtmenu —— OfficeXP/Office2003菜单控件；
BSE Engine ——XP按钮；
ECBridge ——词典控件；
JwldButn2b——XP按钮；
Clock.ocx——时钟控件；
asBubbleForm——气泡控件；
ListBoxEx——用户控件；
注：后来使用的后添加的控件可以不计入本文档，但必须在合适的地方注明。第三部分、基本操作部分
基本操作界面设计草图如下图3：

图1
图2
3.1程序描述
A、目的和意义：
该部分以窗体上的快捷菜单、控制面板的方式为用户提供友好的控制手段，其主要的目的还是使用户能够更方便的使用精灵史努比。因此，无论从外观上还是从功能上都应有一定的可操作性和可用性。
B、特点说明：
该窗体在设计上尽量的符合人们的使用习惯，并且在出现非法操作的情况下，有相应的提示信息输出。
单击并按住该窗体的面板部分或标题部分可以移动该窗体。该面板（图2）可以自动隐藏，类似于QQ的功能。
外观颜色上应以鲜亮为主，可以换肤；根据皮肤还可以选择相应的颜色，并适当配以较鲜艳的皮肤，满足不同人的需要。
菜单的设计应在两个方面考虑：1、使用上，在使用上应尽量让用户感觉到方便又符合人们的习惯。分类要明确、细致。2、外观上，应考虑使用当今比较流行的菜单样式，显得比较华丽。尽量的能让用户可以按照自己的意愿去改变菜单的样式，在选项里去设置。
3.2功能
用户的操作采用IPO图表示如下：
1、用户所做的操作

输 入
1、根据用户操作信息执行处理；

处 理
1、根据不同的指令，在屏幕上给出相应的动作或信息；
输 出

图4：用户操作处理：IPO
3.3性能
灵 活 性：窗口响应绝大部分的快捷菜单和控制面板操作；
时间特性：响应鼠标单击的时间在2~3秒之间（考虑到鼠标事件较多处理较繁琐）；
3.4输人项
输入的数据是户执行的各种操作，包括鼠标、键盘、语音控制等操作。
3.5输出项
输入情况
输出情况
右击快捷菜单，选择任意的选项
根据选择的命令执行相应的操作；
通过控制面板，选择你所需要的选项
根据你的选择作出响应的操作；
通过语音控制
根据输入的语音指令，作出相应的动作；
3.6算法
本部分没有采用自定义的算法。
可修复
有错误操作
退出
显示主操作界面
用户的各种操作指令
执行相应判断处理
作出相应的提示
根据相应的指令作出相应的动作

开始
3.7流程逻辑

相应的指令

3.8接口、
SAPI SDK是微软公司免费提供的语音应用开发工具包，这个SDK中包含了语音应用设计接口（SAPI）、微软的连续语音识别引擎（MCSR）以及微软的语音合成（TTS）引擎等等。目前的5.1版本一共可以支持3种语言的识别 (英语，汉语和日语)以及2种语言的合成（英语和汉语）。SAPI中还包括对于低层控制和高度适应性的直接语音管理、训练向导、事件、语法编译、资源、语音识别(SR)管理以及TTS管理等强大的设计接口。其结构如图(1)：

图(1)
语音引擎则通过DDI层（设备驱动接口）和SAPI(SpeechAPI)进行交互，应用程序通过API层和SAPI通信。通过使用这些API，用户可以快速开发在语音识别或语音合成方面应用程序。
Public WithEvents vox As SpeechLib.SpVoice '定义获得声音变量
Dim WithEvents RecoContext As SpSharedRecoContext
Dim Grammar As ISpeechRecoGrammar
说明：以上所有对象的声明，都放的通用声明中。
3.9存储分配
本程序在高级语言Visual Basic进行编码，直接的内存分配由VB运行时分配。
本组件内所依赖的变量、结构要求全部在组件元素内申明。
3.10注释设计
注释设计请参考《Visual Basic 可视化程序设计》的附录部分。
3.11限制条件
在编码时用到的各种控件必须经过注册，并且在运行时，客户端程序必须安装有VB运行时的动态连接库。
3.12测试计划
测试日期、测试人员安排请参考测试计划，测试用例的具体内容，请参考测试用例说明。
3.13尚未解决的问题
本模块在设计时又考虑不到的情况，具体实现方法在编码时标注清楚。
第四部分、其它附加功能及帮助系统

4.1 程序描述
本程序设思想是让该精灵史努比通过鼠标、语音控制精灵完成搬箱子、跳上箱子、跳下箱子、
放置小球、追小球、放置火圈、跳火圈等一系列的动作，还能够控制系统，像我的电脑、网上邻居等。能够让用户感到娱乐、实用是本模块的设计目的。
4.2 功能

主要功能就是给用户带来娱乐，以此让用户的心情更加舒心。
4.3 性能
灵活性：响应鼠标操作和键盘、语音控制操作。
时间性：鼠标，语音响应快，在毫秒级，没有延迟。
4.4 输入项
（输入项放到输出项中一起对比）
4.5 输出项
输入项
输出项
输入一个指令
根据指令作出相应的动作和操作
4.6 算法
本部分没有采用自定义的算法。
4.7 逻辑流程

开始
主要用户操作界面
用户的各种操作指令
判断用户的操作指令
显示结果
正确
显示正确的动作
错误
作出一定的提示该用户指令错误
用户重新发送指令

图 14 流程图
4.8 接口
4.9 存储分配
本程序在高级语言Visual Basic进行编码，直接的内存分配由VB运行时分配。
4.10 注释设计
注释设计请参考《Visual Basic 可视化程序设计》的附录部分。
4.11 限制条件
输入项都不能为空
4.12 测试计划
测试日期、测试人员安排请参考测试计划，测试用例的具体内容，参考测试用例说明。
4.13 尚未解决的问题
设计的合理性和使用性有待优化。
5.1 定时提醒
5.1.1 描述
在定时提醒界面中输入提醒的时间、提示的内容
5.1.2 功能
用户自定义时间,当到达用户设定的时间系统自动提示.
5.1.3 性能
灵活性：支持鼠标、语音操作。
5.2 屏幕保护
5.2.1 描述
史努比在附加功能中带有屏幕保护这一个选项.他为用户提供一种全新的屏保方式.用户可以根据自己的爱好来改变屏保。
5.2.2 功能
为用户提供一种特殊的屏保样式.
5.2.3 性能
使用键盘输入、鼠标，语音控制操作。

5. 3 翻译
5.3.1描述
一个简单的单词翻译附加功能。
5.3.2 功能
输入一个你所需要翻译的单词，并进行该单词的朗读。
5.3.3 性能
具有灵活性， 用键盘、鼠标控制

5.4 帮助系统
帮助系统采用文本帮助与视频帮助结合，编写参照程序开发过程设计，在项目结束时生成。

第五部分、项目分工
 林 波(Lin):本团队的队长，各方面能力强，知识全面，逻辑能力和编程能力突出。在软件开发过程中，主要负责编程和程序设计文档的编写。
 石洪波(Shi):各方面能力强，知识全面，在软件开发过程负责编程设计和基本功能的实现及实用手册的编写。
 孙新志(Sun):各方面能力强，知识全面，在软件测试方面有一定的能力。在软件开发过程负责编程设计和基本功能的实现及测试文档等文档的编写。
 孟文静(Meng):各方面能力强，知识全面，在软件开发过程中主要负责3D动画的制作、图片处理及软件帮助系统的编写，使得本软件 更具有人性化。

 徐晓娜(Xu): 各方面能力强，知识全面，在软件开发过程中主要负责3D动画的制作、图片处理及软件帮助系统的编写，使得本软件更具有人性化。
指导老师：姚立娟 E-mail：
曲文尧 E-mail：
吕风顺 E-mail：
张宗国 E-mail：

提供联机帮助以及关于本播放器的一些信息

11