系统需求分析说明书.doc

PCS个人代码在线共享管理系统需求分析说明书案卷号3日期2009/10/27PsnCodSharer个人代码在线共享管理系统软件需求说明书作 者： 张 倩 完成日期： 2009/10/27 签 收 人： 曹冠龙、刘 洋、吕佳芯 签收日期： 2008/11/02 修改情况记录：版本号修改批准人修改人安装日期签收人V1.1张 倩张 倩2009/12/15刘 洋 注：如上修改记录只表明主要版本更新，详细记录参见Dropbox记录PCS个人代码在线共享管理系统需求分析说明书目录第一章 引言11.1编写目的11.2范围11.3定义11.4参考资料1第二章 项目概述12.1产品描述12.2产品功能22.3一般约束2第三章 具体需求23.1功能需求23.1.1验证登陆23.1.2密码找回33.1.3更新个人信息33.1.6添加评论/留言33.1.7删除评论/留言43.1.8新建文档43.1.9删除文档43.1.10阅读文档53.1.11收藏文档53.1.12新建代码63.1.13更新代码63.1.14删除代码63.1.15代码查看73.1.16代码搜索73.1.17新建标签83.1.18更新标签83.1.19删除标签83.1.20代码发布动态93.1.21代码收藏动态93.1.22代码评论动态93.1.23代码更新动态103.1.24新注册信息动态103.2外部接口需求103.2.1用户接口103.2.2软件接口103.3性能需求1111第一章 引言1.1编写目的详细定义本项目的需求，供数据库开发人员，数据库管理人员、程序开发人员使用。1.2范围a. 软件系统名称为PsnCodSharerb. PsnCodSharer通过搭建在线代码仓库，供个人更好的管理代码，以获得细粒度的代码版本控制，并通过代码的参阅和分享实现不同用户之间的交流。c. 本系统的应用范围包括：1） 搭建在线代码仓库，提供代码的收藏和分享，实现不同用户之间的交流。2） 供个人创建、参阅、更新和管理代码，进行简单的版本控制，并可实现代码的高亮显示。1.3定义Admin: Administration 管理Psn: Personal 个人的PCS: PsnCodeSharer 个人代码在线共享管理系统1.4参考资料1. PsnCodeSharer个人代码在线共享管理系统数据库设计说明书2. PsnCodeSharer个人代码在线共享管理系统详细设计说明书第二章 项目概述2.1产品描述产品旨在为程序开发人员和编程爱好者提供一个满意的代码分享平台。随着不断学习和实践，编程人员的知识和经验逐渐丰富，好的代码可以保存起来，形成个人代码库，用时只需查阅代码库，其它时候则可以不断更新和丰富，方便管理。目前离线版的个人代码管理软件已经很好的实现了这一功能。本产品是基于Web平台的个人在线代码共享软件。其特点是可以个性化管理代码，通过在线手动修改代码和自动保存修改记录实现简单的版本控制；本产品可以在线浏览全部源码页，无需下载查看，还可加入收藏；以评论、留言以及邮件收发方式让用户参与体验，体现了web 2.0的思想。2.2产品功能a. 用户信息管理，包括新用户注册，密码找回，更新个人信息，添加评论/留言，删除留言；b. 代码管理，包括新建代码，删除代码，阅读代码，收藏代码，代码查看，代码搜索；c. 条目管理，包括新建条目，更新条目，删除条目；d. 标签管理，包括新建标签，更新标签，删除标签；e. 用户动态管理，包括代码发布动态，文档收藏动态，代码评论动态，代码更新动态，新注册信息动态；f. 支持邮件的收发。2.3一般约束a. 使用Windows操作系统，可用于Windows XP及以上平台b. 使用Apache Tomcat 6.0服务器c. 使用SQL Server 2005d. 使用JSP编程e. 面向IE 6.0及以上第三章 具体需求3.1功能需求3.1.1验证登陆a. 输入1） 输入数据包括：用户名、密码、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 密文传送密码；3） 在数据库中依据输入信息验证；4） 返回验证信息。c. 输出1） 如验证通过则输出登陆成功并跳转至主窗口；2） 如未验证通过则输出登陆失败并返回登录窗口；3） 如发生错误则输出错误信息。3.1.2密码找回a. 输入1） 输入数据包括：注册用户名、注册邮箱、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 在数据库中依据输入信息验证；3） 将密码发至用户邮箱；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.3更新个人信息a. 输入1） 输入数据包括：除用户名和原密码外注册信息中需要更新的属性、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性； 2） 密文传送密码；3） 在数据库中更新用户信息；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.6添加评论/留言a. 输入1） 输入数据包括：评论内容、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限；3） 在数据库中添加信息；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.7删除评论/留言a. 输入1） 输入数据包括：选择目标评论/留言，动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限；3） 在数据库中删除该信息，级联删除相关信息，若发生错误则回滚事务；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.8新建代码a. 输入1) 输入数据包括：代码标题、创建者（编号）；2) 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1) 检查输入数据的有效性；2) 检查操作者的权限；3) 在数据库中添加项目文档；4) 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.9删除代码a. 输入1) 输入数据包括：选择目标代码（编号）；2) 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1) 检查输入数据的有效性；2) 检查操作者的权限；3) 在数据库中删除项目文档，级联删除相关信息；若发生错误则回滚事务；4) 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.10阅读代码a. 输入1) 输入数据包括：选择目标文档（编号）；2) 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1) 检查输入数据的有效性；2) 检查操作者的权限；3) 提取数据库对应该文档的最新条目；4) 查询数据库，突出显示该读者未阅读的、有冲突的条目等；5) 按树结构逐级查看；6) 返回执行信息。c. 输出1) 显示文档条目，突出显示该读者未阅读的条目；2) 如果发生错误则输出错误信息。3.1.11收藏代码a. 输入1） 输入数据包括：选择目标文档（编号）；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1) 检查输入数据的有效性；2) 检查操作者的权限；3) 在数据库中添加信息；4) 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.12新建条目a. 输入1） 输入数据包括：标题、标签名称、选择语言、选择代码及界面风格、权限、代码内容、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性，过滤非法信息；2） 检查操作者权限；3） 在数据库中添加信息；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.13更新条目2009-2010课内项目，暂不完成此功能a. 输入1） 输入数据包括：选择目标代码（编号）、代码更新后的内容、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限； 3） 在数据库中执行添加代码信息操作；4） 原代码标记状态为无效；5） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如有并发冲突给出提示；3） 如发生错误则输出错误信息。3.1.14删除条目a. 输入1） 输入数据包括：选择目标代码（编号）、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限；3） 在数据库中删除该信息，级联删除相关信息，若发生错误则回滚事务；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.15代码查看a. 输入1） 输入数据包括：选择目标代码（编号）；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者的权限；3） 提取数据库对应该代码内容的最新信息；4） 按所选代码的语法规则高亮显示该代码信息；5） 返回执行信息；c. 输出1） 按所选代码的语法规则高亮显示该代码信息；2） 如果发生错误则输出错误信息。3.1.16代码搜索a. 输入1） 输入数据包括：选择各项搜索条件；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者的权限；3） 提取数据库对应该搜索条件的所有相关信息（不区分大小写）；4） 按所选搜索方式显示查询信息；5） 返回执行信息；c. 输出1） 按所选搜索方式显示查询信息；2） 如果发生错误则输出错误信息。3.1.17新建标签a. 输入1） 输入数据包括：标签名称、选择语言、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。 b. 加工1） 检查输入数据的有效性，过滤非法信息；2） 检查操作者权限；3） 在数据库中添加信息；4） 返回执行信息。 c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.18更新标签a. 输入1） 输入数据包括：选择目标标签（编号）、标签更新后的内容、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限； 3） 在数据库中执行更新信息操作；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.19删除标签a. 输入1） 输入数据包括：选择目标标签（编号）、动态验证；2） 以上各项数据类型及取值范围参见参考资料1的3.1节。b. 加工1） 检查输入数据的有效性；2） 检查操作者权限；3） 在数据库中删除该信息，不级联删除相关信息，若发生错误则回滚事务；4） 返回执行信息。c. 输出1） 如正常则输出操作成功；2） 如发生错误则输出错误信息。3.1.20代码发布动态a. 输入1） 输入数据：无(直接主页显示)或用户名（点击其他用户名），下同b. 加工1） 检查操作者的权限；2） 在数据库中以多表查询显示若干条发布时间最晚的包含用户名、代码名、和发布时间的信息3） 返回执行信息；c. 输出1） 分条显示代码发布动态信息；2） 如果发生错误则输出错误信息。3.1.21代码收藏动态2009-2010学年课内项目，暂不完成3.1.21和3.1.22功能a. 输入1） 输入数据：无或用户名b. 加工1） 检查操作者的权限；2） 在数据库中以多表查询显示若干条收藏时间最晚的包含用户名、代码名、和收藏时间的信息3） 返回执行信息；c. 输出1） 分条显示代码收藏动态信息；2） 如果发生错误则输出错误信息。3.1.22代码评论动态a. 输入1） 输入数据：无或用户名b. 加工1） 检查操作者的权限；2） 在数据库中以多表查询显示若干条评论时间最晚的包含评价用户名、被评价代码名、和评价时间的信息3） 返回执行信息；c. 输出1） 分条显示代码评价动态信息；2） 如果发生错误则输出错误信息。3.1.23代码更新动态a. 输入1） 输入数据：无或用户名b. 加工1） 检查操作者的权限；2） 在数据库中以多表查询显示若干条代码更新时间最晚的包含用户名、更新代码名、和更新时间的信息3） 返回执行信息；c. 输出1） 分条显示代码代码更新动态信息；2） 如果发生错误则输出错误信息。3.1.24新注册信息动态a. 输入1） 输入数据：无b. 加工1） 在数据库中查询显示若干条注册时间最晚的包含用户名和注册时间的信息2） 返回执行信息；c. 输出1） 分条显示新注