閱讀860 返回首頁    go 阿裏雲 go 技術社區[雲棲]


軟件工程之概要說明書

在寫完第一遍文檔,寫第二遍文檔的過程,發現了自己的很多不足,沒有把握住主要的內容,將其呈現出來,於是在看完UML後,將其中的圖的內容進行消化,運用,寫完了文檔中最重要的文檔之一——概要文檔

1引言...2

1.1編寫目的...2

1.2背景...2

1.3定義...2

1.4參考資料...2

2總體設計...2

2.1需求規定...2

2.2運行環境...2

2.3基本設計概念和處理流程...3

2.4結構...3

2.5功能器求與程序的關係...3

2.6人工處理過程...3

2.7尚未問決的問題...3

3接口設計...3

3.1用戶接口...3

3.2外部接口...3

3.3內部接口...4

4運行設計...4

4.1運行模塊組合...4

4.2運行控製...4

4.3運行時間...4

5係統數據結構設計...4

5.1邏輯結構設計要點...4

5.2物理結構設計要點...4

5.3數據結構與程序的關係...4

6係統出錯處理設計...5

6.1出錯信息...5

6.2補救措施...5

6.3係統維護設計...5


概要設計說明書

1引言

1.1編寫目的

1、             係統分析員審查軟件計劃、軟件需求分析提供的文檔,提出候選的最佳推薦方案,用係統流程圖,組成係統物理元素清單,成本效益分析,係統的進度計劃,供專家審定,審定後進入設計。

2、             確定模塊結構,劃分功能模塊,將軟件功能需求分配給所劃分的最小單元模塊。確定模塊間的聯係,確定數據結構、文件結構、數據庫模式,確定測試方法與策略。

1.2背景

機房收費係統是由廊坊師範學院委托我公司開發的大型管理係統,主要功能是實現機房的信息化管理,包括上機學生信息管理,管理者信息管理。項目周期一個月,項目背景規劃如表1.1所示

                                   表1.1  項目背景規劃

項目名稱

項目委托單位

任務提出者

項目承擔單位

機房收費係統

廊坊師範學院

王總

策劃部門

研發部門

測試部門

1.3定義

1.4參考資料

1、《信息技術提高班培養計劃V5.1》

1.        測試分析報告

軟件需求說明書

2.        《軟件工程——實踐與理論》/田淑梅等編著. 北京:清華大學出版社,2011.9

ISBN 978-7-302-25470-6

《軟件工程視頻》

《GB8567國標》

2總體設計

2.1需求規定

該係統可以實現不同用戶具有不同的對數據庫的訪問權限,學生注冊、充值、上機、下機、消費情況、退卡等,同時一般用戶可以查看學生餘額、上機記錄、充值記錄、修改密碼;操作員具有一般用戶的權限,並且還可以對學生進行注冊、充值、退卡、收取退還金額查詢、學生基本信息維護、查看操作員工作記錄、查詢學生上機統計信息;管理員具有操作員的權限,並且還可以結賬、對用戶進行增刪改查、查看日結賬和月結賬單。

2.2運行環境

服務器:CPU:1G;內存:4G;硬盤:15G

支持軟件:win7

數據庫係統:Microsoft SQL Server2008

 

2.3基本設計概念和處理流程

      1、登錄功能

                

圖1.1

              首先,雙擊機房收費係統,彈出“係統登錄”窗口,分別輸入用戶名和密碼,在數據庫中進行查詢,如果用戶名和密碼出現錯誤,則彈出提示框,如圖1.2所示,如果登錄成功,則進入如圖1.3,即主界麵,在主界麵輸入卡號就可以上機,點擊下機則下機。

               

                                          圖1.2    

       

                    

圖1.3

3、             一般用戶權限

3、1 學生查看餘額


這塊主要是對學生的餘額進行查詢,在請輸入卡號處輸入卡號,點擊查詢,在下麵就會自動顯示所有信息。

                3、2學生上機記錄查詢


這塊主要對學生的上機記錄進行查看,在“請輸入卡號”處輸入卡號,點擊查詢,則會在下麵的框內顯示所需查詢信息。

                3、3學生充值記錄查詢



  這塊主要顯示學生的充值情況,在“請輸入卡號”處輸入卡號,就會顯示所需信息。

                3、4 學生上機狀態查詢


這塊主要對學生的上機狀態進行查詢,包括多條件查詢,全部查詢,強製下機等。這個窗體是以下幾個窗體的父窗體

                3、4、1上機狀態查詢


這塊主要是通過人為限定條件,進行上機查詢,點擊查詢按鈕,顯示所需顯示的內容。

                3、5 修改密碼


這塊通過輸入舊口令和新口令,對正在登錄的用戶密碼進行修改。

  4、操作員權限

 

 

 

                       4、1學生注冊


這塊主要是進行卡號注冊,還可以對已有學生進行查找,界麵如下:

                       4、1、1學生查看餘額


這塊就是之前圖3、1。

                       4、2充值


這塊主要是給卡充值,在“卡號”處輸入卡號、充值金額,彈出如上圖信息。

                       4、3       退卡


這個界麵主要是進行退卡,彈出退卡信息、

                       4、4   收取金額查詢

在起始日期和終止日期處分別輸入日期,點擊查詢就可以顯示收取金額所需信息,也可以將此表以excel形式導出。

                       4、5 餘額退還信息查詢


在起始日期和終止日期處分別輸入日期,點擊查詢就可以顯示收取金額所需信息,也可以將此表以excel形式導出。

                       4、6   學生基本信息維護


這個界麵主要是通過多條件查詢,對所要維護的學生信息進行條件查詢,然後進行修改,點擊修改按鈕,彈出如圖所示界麵:

                       4、6、1  修改學生信息


這塊主要是將上圖選中的信息進行修改。

                       4、7       學生上機統計信息


這個界麵同樣是通過多條件查詢,對所要查看的學生上機信息進行查詢。也可以到處excel表格。

                       4、8       操作員工作記錄


這個界麵主要是通過多條件查詢對操作員工的信息進行查詢,並可以退出該界麵。

5、管理員權限

                                   5、1 結賬


這個界麵主要是對每個操作員的工作情況進行匯總、結賬,顯示所查看的操作員的購卡、充值、退卡,情況。

                       5、2添加刪除用戶


這個界麵可以查看不同權限用戶的信息,同時可以對不同用戶進行添加和刪除,添加界麵如下圖:

                       5、2、1  添加用戶


在這個界麵中添加所要添加的用戶信息,點擊確定,進行保存。

                5、3   基本數據設定


這個界麵主要是對收費情況進行修改。

                       5、4正在值班教師


這個界麵主要是顯示已登錄過的操作員和正在值班老師的情況,同時還可以點擊退出該界麵。

                       5、5       日結賬單

           

這個界麵主要顯示當天的結賬情況,一旦有更新就會在結賬單中顯示出來。同時還可以連接打印機進行打印,對所打印內容預覽。

                       5、6   周結賬單


這個界麵主要是對所選定的一個時間段內的結賬情況進行查詢,可以進行賬單刷新、打印以及預覽。

 

6、幫助

                       6、1       使用說明


這個界麵主要是提示用戶如何使用該軟件。

                       6、2       關於


這界麵主要展示該軟件的版權及作者信息。

2.4結構

2、4、1  總體架構圖

      

1、  WEB層:即用戶接口層,主要是接收用戶的輸入,並將處理後的結果顯示給用戶

2、  BLL層:業務邏輯層,主要是係統業務邏輯的處理,並將處理結果返回給WEB層。

3、  DAL層:數據庫訪問層,主要負責對數據的訪問和操作數據庫的操作結果返回給BLL層

4、  Entity層:實體層,內部的每一個實體類都對應數據庫的一張表,主要是作為各層之間數據傳遞的參數出現

2、4、2  處理流程

       1、登錄流程圖

             

       2、一般用戶權限

             

       在登錄係統時,如果用戶權限為一般用戶,則隻能具有查詢功能,和修改正在上機用戶密碼的功能。

       “查看學生餘額”界麵需要輸入要查看學生的卡號,首先要確定卡號不為空,其次是判斷該卡是否任然使用,如果還在使用,則可以在student_info表中查到該學生的餘額情況。

       “學生查看上機記錄”界麵需要輸入卡號,首先要確定卡號不為空,其次是判斷該卡是否任然使用,如果還在使用,則可以line_info表中查到該學生的上機情況。

       “學生充值記錄”界麵需要輸入要查看學生的卡號,首先要確定卡號不為空,其次是判斷該卡是否任然使用,如果還在使用,則可以在recharge_info表中查到該學生的充值情況。

       “學生上機狀態查詢”界麵有三個功能,查詢,全部顯示,上機管理。首先,查詢功能中需要輸入字段名、操作符、要查詢的內容,如果需要多條件查詢,還要輸入組合條件。涉及到line_info表,還可以直接顯示全部正在上機學生,單擊要強製下機的學生可以強製下機。             

 

3、操作員

       操作員主要是對上機學生進行注冊、充值以及退卡操作,還可以查看金額收取、退還情況,對學生的基本信息進行維護,查看操作員的工作情況等。

4、管理員


       管理員主要是對收費標準進行製定、還有就是用戶的增刪、結賬等進行查看。

2.5人工處理過程

       在上下機的時候,需要用戶刷卡。

3接口設計

3.1用戶接口

3.2外部接口

ID卡閱讀器

3.3內部接口

4運行設計

4.1運行模塊組合

每個模塊執行單一的功能,模塊內部完成高內聚和與其他模塊低耦合,使每個功能互不影響,都能獨立進行操作。

4.2運行控製

本軟件控製流程:主程序運行,等待用戶的輸入,根據用戶的輸入調用各子模塊

4.3運行時間

各模塊運行時間均應控製在1-2s內。(其中大部分為響應用戶的動作)   

5係統數據結構設計

5.1邏輯結構設計要點

1、  E-R圖

2、定義表

基本數據設定表basicdata_info

固定用戶每半小時費用

Rate

數值型

臨時用戶每小時費用

Tmprate

數值型

單位遞增時間

Unittime

整型

最少上機時間

leasttime

整型

準備時間

preparetime

整型

最少上機金額

limitcash

數值型

執行者

head

字符串

日期

Date

字符串

時間

Time

字符串

退卡表cancelcard_info

學號

studentno

字符串

卡號

cardno

字符串

退卡金額

cancelcash

數值型

日期

Date

字符串

時間

Time

字符串

執行者

userid

字符串

卡狀態

Status

字符串

日結表checkday_info

上期充值卡餘額

Remiancash

數值型

當日充值金額

Rechargecash

數值型

當日消費金額

Consumecash

數值型

當日退卡金額

Cancelcash

數值型

本期充值卡金額

Allcash

數值型

日期

Date

字符型

周結賬單checkweek_info

上期充值卡餘額

Remiancash

數值型

當日充值金額

Rechargecash

數值型

當日消費金額

Consumecash

數值型

當日退卡金額

Cancelcash

數值型

本期充值卡金額

Allcash

數值型

日期

Date

字符型

上機記錄表line_info’

序列號

Serial

數值型

卡號

Cardno

字符型

學號

Studentno

字符型

姓名

Studentname

字符型

係別

Department

字符型

性別

Sex

字符型

上機日期

Ondate

字符型

上機時間

Ontime

字符型

下機日期

Offdate

字符型

下機時間

Offtime

字符型

消費時間

Consumetime

字符型

消費金額

Consume

字符型

餘額

Cash

數值型

狀態

Status

字符型

機房號

Computer

字符型

正在上機表online_info

卡號

Cardno

字符型

卡型

Cardtype

字符型

學號

Studentno

字符型

姓名

Studentname

字符型

係別

Department

字符型

性別

Sex

字符型

上機日期

Ondate

字符型

上機時間

Ontime

字符型

機房號

Computer

字符型

管理人員工作表onwork_info

工作人員id

Userid

字符型

級別

Level

字符型

登錄日期

Ondate

字符型

登錄時間

Ontime

字符型

機房號

Computer

字符型

充值表recharge_info

序列號

Serial

數值型

學號

Studentno

字符型

卡號

Cardno

字符型

充值金額

Addmoney

字符型

日期

Date

字符型

時間

Time

字符型

工作人員id

Userid

字符型

狀態

Status

字符型

學生信息student_info

卡號

Cardno

字符型

學號

Studentno

字符型

姓名

Studentname

字符型

性別

Sex

字符型

係別

Department

字符型

年級

Grade

字符型

班級

Class

字符型

餘額

Cash

數值型

備注

Explain

字符型

工作人員id

Userid

字符型

狀態

Status

字符型

結賬狀態

Ischeck

字符型

日期

Date

字符型

時間

Time

字符型

工作人員信息user_info

工作人員id

Userid

字符型

密碼

Pwd

字符型

級別

Level

字符型

工作人員姓名

Username

字符型

開戶人

Head

字符型

 

5.2物理結構設計要點

數據的物理結構用存儲表、鏈表或索引表等描述

5.3數據結構與程序的關係

 

表名

英文名

說明

學生信息表

student

學生的基本注冊信息,用於注冊、學生基本信息維護等功能塊

基本數據表

Bisicdata

機房收費標準,用於基本數據設定功能塊的實現

充值表

recharge

用於記錄學生的充值情況

退卡表

Cancelcard

用於記錄學生的退卡情況

上機記錄表

Line

用於記錄學生上機的情況,用於查看學生上機記錄和學生上機狀態查看的功能塊實現

正在上機記錄表

Online

用於學生正在上機的記錄,正在上機學生查看功能塊的實現

操作員工作記錄表

Worklog

用於記錄操作員的工作情況

正在值班教師記錄表

Onwork

用於記錄正在上機的值班老師

用戶信息表

User

用於記錄可以登錄該係統的用戶的信息

日結賬表

Checkday

用於日結賬單

周結賬單

Checkweek

用於周結賬單

 

 

6係統出錯處理設計

6.1出錯信息

 

序號

出錯狀況

解決方法

1

數據庫備份容量過大,服務器運行緩慢

定期維護減少冗餘

2

突然斷電

使用後備電源

3

數據丟失

數據庫鏡像還原

 

6.2補救措施

a.      後備技術說明準備采用的後備技術,當原始係統數據萬一丟失時啟用的副本的建立和啟動的技術,例如周期性地把磁盤信息記錄到磁帶上去就是對於磁盤媒體的一種後備技術;

b.      降效技術說明準備采用的後備技術,使用另一個效率稍低的係統或方法來求得所需結果的某些部分,例如一個自動係統的降效技術可以是手工操作和數據的人工記錄;

c.      恢複及再啟動技術說明將使用的恢複再啟動技術,使軟件從故障點恢複執行或使軟件從頭開始重新運行的方法。

d.      當出現大的程序問題啟用備份程序;如果無法啟用備份程序則隻能關閉網站進行搶修

6.3係統維護設計

在係統設計時,沒有專用的維護模塊

最後更新:2017-04-03 12:53:49

  上一篇:go HI3531的nand flash測試
  下一篇:go Tomcat啟動報錯:java.lang.IllegalArgumentException: Can't convert argument:null