通過實例學習編寫需求文檔

通過實例學習編寫需求文檔

下面通過編寫“中國滑雪網”需求文檔，一步一步講解需求文檔是如何編寫的。網站需求說明書的格式一般如下所示。

首先是封皮：中國滑雪網  系統說明書

文件標識：	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 附件

無