欢迎光临!

通过实例学习编写需求文档

通过实例学习编写需求文档

下面通过编写“中国滑雪网”需求文档,一步一步讲解需求文档是如何编写的。网站需求说明书的格式一般如下所示。

首先是封皮:中国滑雪网  系统说明书

文件标识:

MYLIFE-SNOW-01

当前版本:

1.0

编    制:

TodayNow

审    核:

TodayNow

编制日期:

2012-5-12

发布日期:

 

关联文件:

 

其次编写目录。

目    录

目    录... 9

1 引  言... 10

1.1 文档目的... 10

1.2 背景... 10

1.3 术语和缩写解释... 11

1.4 参考资料... 11

2 系统概述... 11

2.1 系统目标... 11

2.2 系统范围... 12

2.3 系统总功能... 12

2.4 系统结构与分布... 15

2.5 约束条件... 17

2.5.1 运行平台、关键技术、开发工具... 17

2.5.2 外购组件、客户提供组件、重用策略... 18

2.5.3 假定与依赖... 18

2.5.4 遵循的行业标准... 18

2.5.5 遵循的客户标准(客户特定标准)... 18

3 需求规格... 19

3.1 功能需求... 19

3.2 界面需求... 20

3.3 故障处理需求... 20

3.4 统一的异常处理... 20

4 非功能说明... 21

4.1 处理能力... 21

4.2 业务受理要求... 21

4.3 存储要求... 21

4.4 数据库容量... 21

4.5 接口性能... 21

4.6 系统可用性... 22

4.7 系统可靠性... 22

4.8 系统可维护性... 22

4.9 系统安全性... 22

5 附件... 22

 

1 引  言

1.1 文档目的

        本文档是Mylife公司“中国滑雪网”的基础文档,作为界定项目范围的主要基础,也作为本项目验收的主要依据。同时本文的提供项目主管负责人、项目经理、技术开发人员、测试人员理解需求之用。

1.2 背景

       系统名称:中国滑雪网

项目提出者:MyLife

开发者:Mylife

纵观中国互联网如火如荼,某个行业都有一个综合网站,但是目前中国滑雪确缺少这样一个综合门户。这个网站的目的为滑雪爱好者提供一个学习交流的平台,让志同道合者亲密接触。

1.3 术语和缩写解释

本系统设计到的术语词汇如下所示:

词汇名称

词汇含义

备注

 

 

 

 

1.4 参考资料

2 系统概述

       中国滑雪网主要为滑雪爱好者提供滑雪资讯,滑雪场、滑雪知识、滑雪装备等等还为滑雪爱好者之间交流提供一个平台,形成一个滑雪爱好者的圈子,为滑雪爱好者提供方便。

     2.1 系统目标

   中国滑雪网需要实现以下目标:

● 为滑雪爱好者推荐全国最好的滑雪场地和滑雪信息

● 为滑雪爱好者推荐最好的滑雪装备

● 为滑雪爱好者提供滑雪知识

● 为滑雪爱好者提供交流平台

滑雪爱好者可以在这里找到同道中人,学习到滑雪知识,体会到滑雪乐趣,获取到滑雪信息,索罗到最适合您的滑雪装备。

 

     2.2 系统范围

       本项目的名称是“中国滑雪网”,是Mylife公司为网络用户提供一个滑雪交流的平台。

  2.3 系统总功能

按照系统实现的目标和要求,将系统分为前台和系统管理后台两个部分。前台分为:滑雪场、滑雪知识、滑雪图片、滑雪视频、滑雪交流五大模块。系统管理后台主要负责管理前台功能模块的数据,供系统管理员使用。

根据以上要求本网站要求实现的业务功能如下表所示。

序号

一级功能

二级功能

优先级

备注

前台

1

滑雪新闻

 

 

2

 

评论新闻

 

3

滑雪场

 

 

4

 

评价评论滑雪场

 

5

 

组团滑雪

 

6

滑雪知识

 

 

 

 

分享滑雪知识

 

7

滑雪图片

 

 

8

 

评论图片

 

9

滑雪视频

 

 

10

 

评论视频

 

11

滑雪交流

 

 

12

 

发表主题

 

13

 

回复主题

 

14

账户

 

 

15

 

注册

 

16

 

登录

 

17

 

注销

 

18

 

个人资料

 

19

 

发表评论管理

 

20

 

发表的滑雪场信息

 

21

 

发表的图片信息

 

22

 

发表的视频信息

 

23

 

好友管理

 

25

 

站内信

 

26

 

组团滑雪信息

 

后台管理系统

27

管理员帐号

 

 

28

 

管理员登录

 

29

 

密码修改

 

30

 

注销

 

31

新闻管理

 

 

32

 

新闻列表

 

33

 

添加/修改/删除新闻

 

34

滑雪场管理

 

 

35

 

滑雪场列表

 

36

 

审核滑雪场

 

37

 

添加/修改/删除滑雪场

 

38

滑雪图片管理

 

 

39

 

滑雪图片列表

 

40

 

审核滑雪图片

 

41

 

添加/修改/删除滑雪图片

 

42

滑雪视频管理

 

 

43

 

滑雪视频列表

 

44

 

审核滑雪视频

 

45

 

添加/修改/删除滑雪视频

 

46

滑雪交流

 

 

47

 

滑雪交流列表

 

48

 

滑雪交流修改/添加/删除

 

49

用户列表

 

 

50

 

用户活跃状态管理

 

51

 

用户等级管理

 

52

 

用户信息查看、禁用等

 

54

统一异常处理

 

 

 

  2.4 系统结构与分布

按照2.3中对总体功能描述、本系统功能结构如下:

 

2.5 约束条件

           2.5.1 运行平台、关键技术、开发工具

              1) 操作系统

      本系统建成后将运行在windows 2003系统之上。

      2) 数据库系统

     本系统将运行在Microsoft SQL Server 2005数据库管理系统之上。

              3) 开发语言及工具

      开发语言为c#,前台开发工具为Adobe Photoshop CS5和Adobe Dreamweaver CS5,后台开发工具为Microsoft Visual Studio 2005,开发数据库为Microsoft SQL Server 2005。

           2.5.2 外购组件、客户提供组件、重用策略

           2.5.3 假定与依赖

         无

           2.5.4 遵循的行业标准

              无

2.5.5 遵循的客户标准(客户特定标准)

              无

3 需求规格

     3.1 功能需求

前台

滑雪新闻

 

 

滑雪场信息

 

 

滑雪知识

 

 

滑雪图片

 

 

滑雪视频

 

 

滑雪交流

 

 

用户中心

 

 

后台

网站基本信息

 

 

滑雪新闻管理

 

 

滑雪场管理

 

 

滑雪知识管理

 

 

滑雪图片管理

 

 

滑雪视频管理

 

 

滑雪交流

 

 

用户管理

 

 

账户管理

 

 

后台用户管理

 

 

订单管理

 

 

日志管理

 

 

模板管理

 

 

帮助管理

 

 

 

     3.2 界面需求

●页面简易、清爽、布局清晰,突出色调。

●网站迎合搜索引擎优化;

●网站前台采用DIV+CSS

●网站整体采用模板设置,后台可更新设计模板,雪场可以选择模板。

     3.3 故障处理需求

系统运行难免会出现一些故障,对此我们提出以下建议和要求。

1) 对用户提交的重要资料及时备份(如用户注册资料等)。

2) 当系统数据库发生问题要及时向用户返回相关故障。

     3.4 统一的异常处理

 异常处理按异常级别(错误、警告、信息)显示异常信息:

错误:显示“发生未知错误”;

警告:原样输出跟踪信息,即Exception.Message属性值;

信息:原样输出跟踪信息,即Exception.Message属性值;

同时记录信息到文本文件,以便处理,要求每天新建一个文本文件,命名规范如下:

MyLife_Debug_Log_YYYY_MM_DD.txt

记录内容如下:

发生时间           跟踪信息          堆栈信息

HH:MM:SS        Exception.Message   Exception.Trace

   

4 非功能说明

     4.1 处理能力

1)能同时满足100人同时在线

2)网络带宽要求100M以上

     4.2 业务受理要求

1) 业务受理操作相应时间不超过3S

2) 复杂查询相应时间不超过3S

     4.3 存储要求

     4.4 数据库容量

按照本系统在1年内注册用户达到2万的标准,硬盘以RAID5为例,本系统需要的数据库容量50G。

     4.5 接口性能

     4.6 系统可用性

1) 使用简单

2) 有权限的东西,必须注册登录才可见

 

     4.7 系统可靠性

        系统一周7天24小时运转正常,每周平均无故障时间超过167个小时

4.8 系统可维护性

系统在试运行阶段需要记录下所有操作日志,记录出现问题的现场,并能通过邮件向维护人员报告系统状态。

4.9 系统安全性

1) 整个系统需要用户必须经过身份验证才能发布信息;

2) 能防止SQL注入攻击和跨站脚本攻击

5 附件

posted on 2018-07-10 20:39  花拉子米  阅读(599)  评论(0编辑  收藏  举报
版权所有