系统功能说明.docx
《系统功能说明.docx》由会员分享，可在线阅读，更多相关《系统功能说明.docx（20页珍藏版）》请在冰豆网上搜索。
系统功能说明
产品维护管理系统
功能说明
目录
1.功能需求3
1.1.FAQ管理3
1.1.1.新增问题3
1.1.2.解决问题3
1.1.3.状态管理3
1.1.4.FAQ查询4
1.1.5.FAQ文档导出5
1.1.6.删除6
1.1.7.修改6
1.1.8.发布FAQ6
1.2.BUG管理6
1.2.1.新增6
1.2.2.状态管理7
1.2.3.查询7
1.2.4.删除9
1.2.5.修改9
1.2.6.导出9
1.2.7.统计分析10
1.3.版本更新管理10
1.3.1.查询版本信息10
1.3.2.版本差异比较11
1.3.3.版本发布管理11
1.4.帮助文档管理12
1.4.1.帮助文档辅助生成12
1.4.2.根据版本导出13
1.5.分类导出13
1.5.1.最新FAQ导出13
1.5.2.最新BUG导出13
1.5.3.最新帮助文档导出13
1.5.4.最新版本更新信息导出13
2.数据字典14
2.1.BFVFaq（faq信息表）14
2.2.BFVFaq_Log（问题答案信息表）14
2.3.BFVBug（bug信息表）14
2.4.BFVBug_Careness（bug关注信息表）15
2.5.BFVBug_Log（bug修改信息表）15
2.6.BFVVersion（version信息表）16
2.7.BFVHelp（帮助文档信息表）16
1.功能需求
1.1.FAQ管理
FAQ管理即FastAnswerQuestion管理,它的定位是软件的开发团队所使用的相应管理。
每一个问题都会有很多个答案，因此，相应管理员需要按照一定的规则，萃取一个最佳答案，使其成为FAQ。
系统认为有权提供答案的都是该软件的专业人员，因此他们同时可以更改问题的基本状态。
1.1.1.新增问题
顾名思义，即新加一个问题，要数据库的BFVFaq表相应的新增一条记录，要注意的是，BFVFaq表q_Autostatus字段为未解决；BFVFaq表q_Status为空。
它有一定的规定，即有必填栏目的设定，如下：
1.隶属项目
2.隶属版本
3.详细功能选择
4.问题标题
5.问题描述
1.1.2.解决问题
顾名思义，即解答问题。
需要填写的内容有：
解答内容、解答时间（是否需要审核答案由后台设定）。
1.1.1.
1.1.2.
1.1.3.状态管理
即实时管理问题的状态，问题的状态主要包括：
1.未解决
2.已解决
3.处理中
4.FAQ
5.忽略
1.1.3.1.基本状态管理
所有人都可以把问题状态变为未解决，已解决，处理中。
1.1.3.2.过期检测
如果一个FAQ条目所对应的功能需求分析条目已经更改，则该FAQ已经失效，自动标记为“可能已过时”；但是否过时还需相应的管理员进一步考察和核实，此处只是可以做一个提示效果。
使用本系统的管理员应该在合适的时候检测上述情况，并及时处理这种FAQ，以保证系统的质量。
1.1.4.FAQ查询
此处的FAQ分类查询具有检索功能，众所周知，分类查询可以增强条理性和清晰性，可以大大提高查询的速度，为客户带来便利。
客户所需要输入的查询条件与数据库的表对应如下：
所属项目存储在BFVFaq表q_Project字段中；所属功能存储在BFVFaq表q_Function字段中；自动状态存储在BFVFaq表q_Autostatus字段中；版本存储在BFVFaq表q_Version字段中；问题标题存储在BFVFaq表q_Title字段中；问题内容存储在BFVFaq表q_Question字段中；起始时间存储在BFVFaq表q_Time字段中；结束时间（这里表示最佳答案的发布时间，即问题的解决时间）存储在BFVFaq_Log表faq_Edittime字段中；问题发布人存储在BFVFaq表q_Publisher字段中；留言人存储在BFVFaq_Log表faq_Editor字段中。
在用户查看某一特定FAQ的详细信息时，显示的界面上的所有内容，与数据库的相应表的对应关系如下：
所属功能存储在BFVFaq表q_Function字段中；所属版本存储在BFVFaq表q_Version字段中；问题标题存储在BFVFaq表q_Title字段中；问题内容存储在BFVFaq表q_Question字段中；自动状态存储在BFVFaq表q_Autostatus字段中；起始时间存储在BFVFaq表q_Time字段中。
BFVFaq_Log表所有字段显示可能答案和最佳答案。
按照每个人的喜好，本系统从五个角度进行分类查询；
1.1.4.1.按时间查询
即根据起始时间和终止时间进行查询，从而显示出此时间段内所有的问题。
1.1.4.2.按版本查询
即根据起始版本和终止版本进行查询，从而显示出两版本之间所有的问题。
1.1.4.3.按项目查询
即按照问题所属的项目类进行检索。
1.1.4.4.按发布人查询
即按照增加问题的用户，进行相应的查询和检索。
1.1.4.5.按解决人查询
即按照解决问题的相关人员，进行相应的查询和检索。
1.1.4.6.按内容查询
按FAQ的大体内容进行检索，也可以是关键字查询。
1.1.4.7.按功能查询
即按照FAQ具有的功能，进行相应的查询和检索。
1.1.4.8.按问题状态查询
即按照问题现在的状态，如未解决，已解决，处理中进行相应的查询和检索。
1.1.5.FAQ文档导出
文档导出，即将FAQ条目导出；导出的条目仅包括“已解决”的条目（也可允许用户进行导出的调节）。
导出应该依照版本为基准，可以导出从最早版本到选定导出版本之间的所有“已解决”条目。
导出前必须进行“状态管理--状态检测”操作，并提醒出现的“可能已过时FAQ”，以便让此类FAQ得到进一步的确认。
在导出前，可以按照其起始版本、结束版本、起始时间、结束时间、发布人、解决人、关键字选择要导出的FAQ，并可以按照个人选择导出的形式，如Txt格式，Word文档格式。
FAQ文档导出的内容与数据库中表的相应关系如下：
所属功能存储在BFVFaq表q_Function；所属版本存储在BFVFaq表q_Version；
问题标题存储在BFVFaq表q_Title；问题内容存储在BFVFaq表q_Question；手动状态
存储在BFVFaq表q_Status。
1.1.5.1.Txt格式
即按照用户意愿，选择导出的文件的格式为Txt记事本格式。
1.1.5.2.Word文档
即导出的文件以Word文档的形式进行显示。
1.1.5.3.HTML格式
1.1.6.删除
登陆后台的管理员有权按照一定的标准和需要，进行相应的删除操作。
每删除一次，对应删除BFVFaq中的一条记录和BFVFag_Log表中对应的所有记录。
1.1.7.修改
登陆后台的管理员有权按照一定的标准和需要，进行相应的修改操作。
每修改一次，对应修改BFVFaq中的一条记录和BFVFag_Log表中对应的所有记录。
1.1.8.发布FAQ
相应的管理者可以将“已解决”的问题状态改为“FAQ”状态，即在此单独出现一个版块，发布FAQ。
1.2.BUG管理
用来管理用户所提交的所有BUG。
1.2.1.新增
即新增一个BUG，在数据库的相应BFVBug表中，添加一条记录。
所要涉及的内容有以下几项：
1.BUG标题
2.BUG描述
3.日志文件或内存转储文件上传
4.隶属项目
5.隶属版本
6.隶属详细功能
7.提交人（自动）
8.提交时间（自动）
9.指定解决人员（可不填）
1.2.2.状态管理
即管理BUG的可能状态，其主要分以下几类：
1.等待处理（尚未有任何人接收该BUG）
2.正在处理（已经有人开始处理该BUG，例如单击了“我来处理”按钮，此状态中可以有其他人同时接受）
3.处理结束
4.关闭
5.重开放
6.无意义
1.2.2.1.解决人协作处理
每个接收了这个BUG的人，可以写一条处理方法，并可以随时修改关于这个Bug的解决方案，这里可以描述他当前对解决此BUG的工作状态。
1.2.2.2.责任关联处理
如果有人接收了这个BUG的处理，则这个人挂名于该BUG下。
多个人可以同时处理一个BUG；一个人也可以同时处理多个BUG。
进入BUG管理模块，应该有“我处理的BUG”页面显示我正在处理的BUG。
同时，对于每个“正在处理”的BUG，应当列出其所有的处理人。
1.2.3.查询
此处的BUG分类查询具有检索功能，众所周知，分类查询可以增强条理性和清晰性，可以大大提高查询的速度，为客户带来便利。
在查询Bug时，用户所要输入的信息与数据库表的对应关系如下：
起始版本存储在BFVBug表的bug_Version字段；结束版本存储在BFVBug表的bug_Version字段；发布时间存储在BFVBug表的bug_Time字段；结束时间存储在BFVBug_Log表的bug_Edittime字段；发布人存储在BFVBug表的bug_Publisher字段；参与人存储在BFVBug_Carebess表的bug_Relevant字段；问题状态存储在BFVBug表的bug_Status字段；问题优先级存储在BFVBug表的bug_Grade字段；关键字存储在BFVBug_Log表bug_Answer字段；所属功能存储在BFVBug表bug_Function字段。
在查看某一条Bug的详细信息的界面时，修改Bug相关人的内容会存储在BFVBug_Carebess表的bug_Relevant字段中；修改优先级的内容存在BFVBug表的bug_Grade字段；修改Bug状态存储在BFVBug_Log表的bug_Status_Mod字段；修改Bug的标题存储在BFVBug表中的bug_Title字段；用户进行的留言内容存储在BFVBug_Log表的bug_Answer字段中；用户的修改时间存储在BFVBug_Log表的bug_Edittime字段中；留言者的信息存储在BFVBug_Log表的bug_Editor字段中。
在用户查看一条Bug的详细的信息时，他可以对Bug的内容进行修改。
修改的参与人存储在BFVBug_Carebess表的bug_Relevant字段；问题状态存储在BFVBug表bug_Status字段；问题优先级的修改存储在BFVBug表的bug_Grade字段；bug标题的修改存储在BFVBug表的bug_Title字段；留言的修改内容存储在BFVBug_Log表的bug_Answer字段中。
按照每个人的喜好，本系统从五个角度进行分类查询；
1.2.3.1.按时间查询
即按照增加BUG和解决BUG的时间为标准，进行查询。
1.2.3.2.按版本查询
即按照BUG所属的版本类型进行查询，此处要求使用者熟悉相应的版本号。
1.2.3.3.按项目查询
即按照BUG所属的项目类进行检索。
1.2.3.4.按内容查询
按BUG的大体内容进行检索，也可以是关键字查询。
1.2.3.5.按发布人查询
即按照增加BUG的用户，进行相应的查询和检索。
1.2.3.6.按责任人查询
按照解决BUG的相关人员，进行相应的查询和检索。
1.2.3.7.按问题状态查询
即按照BUG现在的状态，如等待处理（尚未有任何人接收该BUG）、正在处理、处理结束、关闭、重开放、无意义，进行相应的查询和检索。
1.2.3.8.按关注人查询
即按照收藏此BUG的人员为依据，进行相应的查询和检索。
1.2.3.9.按功能查询
即按照BUG具有的功能，进行相应的查询和检索。
1.2.4.删除
管理员登陆后可以按照某种特定的规则进行相应的删除。
其他的任何人无权进行删除操作。
在做删除操作时，BFVBug表、BFVBug_Careness表、BFVBug_Log表都同时删除一条记录。
1.2.5.修改
管理员登陆后可以按照某种特定的规则进行相应的修改。
其他的任何人无权进行修改操作。
在做修改操作时，BFVBug表、BFVBug_Careness表、BFVBug_Log表都同时进行修改。
1.2.6.导出
文档导出，即将BUG条目导出；导出的条目仅包括“已解决”的条目（也可允许用户进行导出的调节）。
导出应该依照版本为基准，可以导出从最早版本到选定导出版本之间的所有“已解决”条目。
导出前必须进行“状态管理--状态检测”操作，并提醒出现的“可能已过时BUG”，以便让此类BUG得到进一步的确认。
导出过程不需要对数据库记录进行修改；但在导出之前需要查询出要导出的Bug，所以这一步需要和数据库的表相对应起来。
用户输入查询条件，起始版本存储在BFVBug表的bug_Ori_Ver字段；结束版本存储在BFVBug表的bug_Solve_Ver字段；发布时间存储在BFVBug表的bug_Time字段；结束时间存储在BFVBug_Log表的bug_Edittime字段；发布人存储在BFVBug表的bug_Publisher字段；参与人存储在BFVBug_Carebess表的bug_Relevant字段；问题状态存储在BFVBug表的bug_Status字段；问题优先级存储在BFVBug表的bug_Grade字段；关键字存储在BFVBug_Log表bug_Answer字段。
1.2.6.1.Txt格式
即按照用户的喜好，选择导出的文件的格式为Txt记事本格式。
1.2.6.2.Word文档
即导出的文件以Word文档的形式进行显示。
1.2.6.3.Excel图表
即将所有的BUG以及相关的解决方案用Excel图表的形式形象的表示出来。
1.2.7.统计分析
此处是要求管理员或相关人员，对所有的BUG进行汇总统计，并做分析。
1.2.7.1.按项目统计
即按照BUG所属的项目类进行统计分析。
1.2.7.2.按时间统计
即按照增加BUG和解决BUG的时间为标准，进行统计分析。
1.2.7.3.按版本统计
即按照BUG所属的版本类型进行统计分析，此处要求使用者熟悉相应的版本号。
1.3.版本更新管理
所谓的版本更新管理，即及时的对版本号，进行更新和管理。
1.3.1.查询版本信息
我们以列表的形式，直观地显示所有的历史版本号。
（对于自动生成的版本号，默认不予显示，只显示已成功发布的版本号，若用户有需要，可以选择显示所有的版本号）。
此处，查询版本信息与数据库表的对应关系如下：
version_Project字段确定每一条记录对应的项目；version_Num储存版本的字符串，如”1.0.22”；version_Formal确定是否是已发布版本，true代表已发布版本；BFVVersionID是每一条版本记录的唯一ID；显示时根据version_Project记录筛选。
1.3.2.版本差异比较
这里我们需要通过共同接口，调用需求分析系统的相应数据来完成操作。
1.3.2.1.功能差异
根据选择的开始、结束版本号，动态的显示出这两个版本之间功能的变化，并显示在网页上。
1.3.2.2.BUG修改
根据选择的开始、结束版本号，动态的显示出在这两个版本之间修正的Bug,并显示在网页上。
用户输入两个版本号，根据后台的version_Project、version_Num和BFVVersionID判断版本范围。
Bug差异比较，通过bug_Ori_Version和bug_Status筛选bug；
输出已经解决的bug，其字段包括以下：
对应功能对应bug_Function；优先级对应bug_Grade；最早出现版本对应bug_Version；Bug标题对应bug_Title；Bug内容对应bug_Question；Bug委托人对应bug_Delegator；Bug添加时间对应bug_Time；Bug发布人对应bug_Publisher。
1.3.2.3.导出
根据选择的开始、结束版本号，以Word、txt等方式导出这两个版本之间所有的更新信息（Bug修改、功能修改）。
将上述两个功能（Bug和更新差异比较）的结果输出。
1.3.3.版本发布管理
本模块主要是对整个项目的版本号进行实时控制，当项目发生改动时，系统提醒更改版本号，可以自动或手动产生新的版本号。
此处，与数据库表的对应关系如下：
版本的唯一ID（自动增加）对应BFVVersionID；新的版本号对应version_Num；版本对应的项目对应version_Project；版本是否发布的字段对应version_Formal。
1.3.3.1.提醒更改版本号
对于发布的版本，当检测到需求发生重大改变的时候，则立即提醒需要及时更新相应版本号。
1.3.3.2.修改版本号
修订版本号，每次BUG增加，则自动号自动加1，主要、次要版本号增加的时候，自动归零。
主版本、次版本由用户输入，且必须要求至少有一项要最少加1。
此处，与数据库表的对应关系如下：
版本的唯一ID（自动增加）对应BFVVersionID；新的版本号对应version_Num；版本对应的项目对应version_Project；版本是否发布的字段对应version_Formal。
1.4.帮助文档管理
这个模块主要通过搜索、提供功能需求的相关内容，辅助用户按照自己的意愿生成帮助文档。
1.4.1.帮助文档辅助生成
进入帮助文档辅助生成模块之前，应该先要求选定一个对应的软件版本，此处选定的版本最好是已发布的已经定型的版本。
如果这个版本是最新版本，且这个版本未发布（即未定型）的话，应该给予警告。
1.4.1.1.辅助信息搜索
针对每项功能，必须通过共同接口，调用需求分析系统中相应的详细信息。
从第三部门需求分析系统获取。
1.4.1.2.帮助文档编辑
对于编辑的帮助文档，以“版本”和“详细功能”作为主要区别进行存档。
还可以通过选择编辑状态（已完成、编写中、未编写）来筛选出想要编辑的功能模块。
列出所有版本：
表示版本先后对应BFVVersionID；版本号对应version_Num；所属项目对应version_Project；是否正式版本对应version_Formal。
储存使用：
帮助条目序号（同功能序号）对应BFVHelpID；帮助内容对应help_Content；帮助标题对应help_Title；帮助版本对应help_Version；帮助所属项目对应help_Project；帮助状态对应help_Status。
1.4.2.根据版本导出
顾名思义，按照帮助文档的相应版本类型进行导出。
列出所有版本：
表示版本先后对应BFVVersionID；版本号对应version_Num；所属项目对应version_Project；是否正式版本对应version_Formal。
导出读取：
帮助条目序号（同功能序号）对应BFVHelpID；帮助内容对应help_Content；帮主标题对应help_Title；帮助版本对应help_Version；帮助所属项目对应help_Project；帮助状态对应help_Status。
1.5.分类导出
本功能是为了方便用户使用而设计的版块，用户可以快捷的导出产品所有的最新信息。
1.5.1.最新FAQ导出
导出最新版本的FAQ。
调用“FAQ导出”功能。
1.5.2.最新BUG导出
导出最新版本的BUG信息。
调用“BUG导出”功能。
1.5.3.最新帮助文档导出
导出最新版本的帮助文档。
调用“针对版本导出帮助文档“功能。
1.5.4.最新版本更新信息导出
导出最新的版本更新信息（BUG修改和功能变化）。
调用第三部门需求系统功能。
2.数据字典
在对本系统（Bug/FAQ/帮助/版本更新管理系统）进行数据库设计时，我们共制作了BFVFaq（faq信息表）、BFVFag_Log（问题答案信息表）、BFVBug（bug信息表）、BFVBug_Carebess（bug关注信息表）、BFVBug_Log（bug修改信息表）、BFVVersion（vertion信息表）、BFVHelp（帮助文档信息表）七个数据表。
具体内容如下：
2.1.BFVFaq（faq信息表）
图表1
字段名
字段含义
是否主键
约束
数据类型
字段大小
BFVFagID
编号
是
不为空
int
4
q_Project
所属项目
不为空
Int
4
q_Function
所属功能
不为空
int
4
q_Status
手动状态
不为空
Char
10
q_Autostatus
自动状态
Char
10
q_Version
版本
不为空
Char
15
q_Title
标题
不为空
Nchar
20
q_Question
问题内容
不为空
Nvarchar
300
q_Time
发布时间
不为空
Char
20
q_Publisher
发布人
不为空
Int
4
2.2.BFVFaq_Log（问题答案信息表）
图表2
字段名
字段含义
是否主键
约束
数据类型
字段大小
BFVFaq_LogID
编号
不为空
char
10
faq_Answer
留言
nvarchar
300
faq_Editor
修改人
不为空
Int
4
faq_Edittime
时间
不为空
Datetime
faq_Bestanswer
最佳答案
2.3.BFVBug（bug信息表）
图表3
字段名
字段含义
是否主键
约束
数据类型
字段大小
BFVBugID
编号
是
不为空
int
4
bug_Project
所属项目
不为空
int
4
bug_Function
所属功能
不为空
Char
20
bug_Status
状态
不为空
char
10
bug_Grade
优先级
Int
4
bug_Ori_Ver
出现版本
不为空
char
15
bug_Solve_Ver
解决版本
char
15
bug_Title
标题
不为空
nChar
20
bug_Question
问题内容
不为空
Nvarchar
500
bug_Delegator
委托人ID
Int
4
bug_Debugfile
内存转储
Char
100
bug_Time
发布时间
不为空
datetime
bug_Publisher
发布人
不为空
int
4
bug_Isvalid
有效性
不为空
2.4.BFVBug_Careness（bug关注信息表）
图表4
字段名
字段含
升级会员 