第一篇:手機遠程服務(wù)軟件功能需求說明書
附件
手機版遠程服務(wù)軟件功能需求說明書
本部分為手機版遠程服務(wù)軟件的功能需求說明,為雙方根據(jù)甲方提供的項目要求共同商定的功能需求,也作為雙方項目驗收的依據(jù)。供應(yīng)商應(yīng)根據(jù)此需求提供完整的實現(xiàn)各功能的軟件。雙方在項目合同執(zhí)行期間和執(zhí)行后提出本規(guī)范書之外的新需求和改動要求,均需雙方商定并另行擬定備忘錄。技術(shù)要求
1.1 總體要求
手機版遠程服務(wù)軟件一款安裝在桌面電腦上的軟件,把安卓手機和電腦連接上后用戶對手機實現(xiàn)對手機的管理功能,以及工程師通過接管用戶電腦借助手機版客戶端功能實現(xiàn)對手機的應(yīng)用支持、咨詢和維護等服務(wù)。產(chǎn)品的研發(fā)分三期完成,本規(guī)范描述一起項目中的功能需求。
1.手機版軟件將整合至蘇寧IT幫客軟件中。PC端基于windows平臺,支持windows XP, Windows Vista和Windows 7.2.手機版遠程服務(wù)軟件一期項目手機管理功能模塊包括:驅(qū)動安裝,應(yīng)用管理,聯(lián)系人管理,文件管理和圖片管理。各模塊具體支持項目詳見詳細功能章節(jié),同時軟件支持嵌入由甲方提供的應(yīng)用市場客戶端模塊,并和應(yīng)用市場提供的鏈接接口,下載相關(guān)應(yīng)用安裝。
3.一期項目僅針對于Android手機系統(tǒng),支持android 2.1以上版本的手機,一期支持完全適配機型20款,詳見附件一起完全適配機型列表。完全適配的定義為以上提到的手機管理功能模塊均支持。
4.界面色調(diào)風(fēng)格和所有彈出框風(fēng)格與蘇寧IT幫客4.0版本保持一致。各個界面、按鈕、標(biāo)簽等規(guī)格以最終提交商定的UI設(shè)計為準(zhǔn)。
詳細功能
2.1 軟件安裝,卸載,升級
此模塊為手機服務(wù)包的嵌入IT幫客的管理,由甲方提供;乙方需提供手機服務(wù)包供甲方使用。
(1)安裝程序由甲方統(tǒng)一打包在蘇寧IT幫客安裝程序中,安裝程序界面中增加安裝手機服務(wù)包復(fù)選框
(2)未安裝手機包的IT幫客中的手機服務(wù)頁嵌入安裝界面,點擊安裝:本機如有安裝包直接安裝;如無,調(diào)用PC下載軟件下載后安裝。安裝好重啟IT幫客客戶端。
(3)安裝后,開始菜單和控制面板可單獨卸載手機服務(wù)模塊
(4)甲方統(tǒng)一進行平臺升級
2.2 驅(qū)動安裝
(1)手機連接時,自動判斷當(dāng)前連接手機的驅(qū)動程序
(2)如本地有驅(qū)動程序直接安裝;如無,從服務(wù)器下載,然后安裝;
(3)安裝完后直接連接
2.3 主頁面
(1)主頁面將嵌入IT幫客手機服務(wù)頁面
(2)支持連接狀態(tài)的顯示,支持連接和斷開連接操作
(3)已連接手機的圖片,型號,操作系統(tǒng)信息顯示(手機圖片可從服務(wù)器獲得)
(4)顯示管理功能按鍵:應(yīng)用管理,通訊錄管理,文件管理和圖片管理,點擊啟動手機服務(wù)軟件并進入相應(yīng)的管理頁面
(5)支持甲方提供的應(yīng)用市場頁面的嵌入
(6)支持通過應(yīng)用市場頁面的應(yīng)用下載鏈接接口下載應(yīng)用
2.4 應(yīng)用管理
(1)應(yīng)用信息列表顯示(用戶軟件,系統(tǒng)軟件,可升級軟件)
(2)應(yīng)用安裝,卸載,備份,升級(升級需與甲方應(yīng)用市場接口,包括應(yīng)用匹配,匹配后的最新版本信息獲取和升級包的獲取)(3)本地應(yīng)用搜索
(4)支持甲方提供的應(yīng)用市場頁面的嵌入
(5)支持通過應(yīng)用市場頁面的應(yīng)用下載鏈接接口下載應(yīng)用
2.5 通訊錄管理
(1)支持聯(lián)系人列表顯示(全部聯(lián)系人,收藏夾)
(2)聯(lián)系人添加,刪除,編輯,導(dǎo)入/導(dǎo)出(一種csv格式)
2.6
文件管理
(1)支持當(dāng)前文件樹結(jié)構(gòu)的顯示
(2)支持文件結(jié)構(gòu)瀏覽的后退,前進,向上層,排序
(3)支持文件夾的新建,文件和文件的刪除,重命名,復(fù)制,粘貼,剪切(右鍵菜單和快捷鍵)
(4)支持當(dāng)前目錄下向緊鄰下一層文件夾的文件拖拽(5)支持當(dāng)前文件夾下基于文件名的文件搜索(6)支持存儲容量信息的顯示
2.7 圖片管理
(1)支持文件縮略圖的顯示(所有圖片,照相機圖片)(2)支持圖片的單選,多選,全選,全不選(3)支持選中圖片的刪除,導(dǎo)出(4)支持從PC端添加圖片
(5)支持點擊查看選中的單個圖片(利用PC系統(tǒng)圖片查看器查看)
第二篇:遠程服務(wù)平臺軟件說明書
用友遠程服務(wù)系統(tǒng)V1.02
用戶手冊
用友遠程服務(wù)系統(tǒng)V1.02 版權(quán)聲明
? 北京億通暢聯(lián)科技有限責(zé)任公司 版權(quán)所有
? 本用戶手冊中的任何信息在未經(jīng)北京億通暢聯(lián)科技有限責(zé)任公司同意的條件下不得以任何方式(包括紙張印刷品、電子出版物、電子文檔等信息傳播媒介)復(fù)制、傳播、摘抄、再發(fā)表。
? 本手冊中的所有信息僅代表產(chǎn)品公布之日億通暢聯(lián)公司的觀點,并且我們無法保證用戶手冊中有偏差信息的存在,我們保留因產(chǎn)品升級或其它原因而更改用戶手冊的權(quán)利。
最終用戶許可協(xié)議
*重要:請認真閱讀──本軟件《最終用戶軟件授權(quán)協(xié)議》(以下稱《協(xié)議》)
這份協(xié)議是您(個人或機構(gòu)團體)與北京億通暢聯(lián)科技有限責(zé)任公司之間就有關(guān)使用、購買億通暢聯(lián)科技軟件產(chǎn)品的法律協(xié)議。本軟件產(chǎn)品包括計算機軟件并且還包括可能在軟件中出現(xiàn)的或包含在軟件中的電子文檔、相關(guān)媒體和印刷材料等等(以下稱“軟件產(chǎn)品”)。您一旦安裝、復(fù)制或以其它方式使用本“軟件產(chǎn)品”,即表示您同意接受本《協(xié)議》中相應(yīng)條款的約束。如果您不同意本《協(xié)議》中的條款,則您不得安裝、復(fù)制或以其他方式使用本“軟件產(chǎn)品”。
此外,一旦您安裝、復(fù)制或以其它方式使用本“軟件產(chǎn)品”的任何“更新件”或其它組件,即表示您同意接受隨附這些“更新件”的任何附加許可條款的約束。如果您不同意隨附這些“更新件”的附加許可條款,則您不得安裝、復(fù)制或以其它方式使用該“更新件”。1.軟件產(chǎn)品許可證
本“軟件產(chǎn)品”受中華人民共和國著作權(quán)法及其他有關(guān)國際版權(quán)條約和其它知識產(chǎn)權(quán)法及條約的保護。本“軟件產(chǎn)品”只是許可使用,而非出售。2.軟件產(chǎn)品使用的許可
億通暢聯(lián)科技將本軟件程序的使用權(quán)授予您。但您必須向本公司作以下保證:
1)不在本協(xié)議規(guī)定的條款之外,使用、拷貝、修改、租賃或轉(zhuǎn)讓本系統(tǒng)或其中的任一部分。2)只在一臺機器上使用本系統(tǒng);
3)為在這一臺機器上使用,出于備份或檔案管理的目的,允許以機器可讀格式制作本系統(tǒng)的拷貝;
4)在他方接受本協(xié)議的條款和條件的前提下,將本系統(tǒng)及許可協(xié)議轉(zhuǎn)讓給另一方使用,如若發(fā)生轉(zhuǎn)讓,原文檔及其伴隨文檔的所有拷貝必須一并轉(zhuǎn)讓對方,或?qū)⑽崔D(zhuǎn)交的拷貝全部銷毀;
5)只在以下之一前提下,將本系統(tǒng)用于多用戶環(huán)境或網(wǎng)絡(luò)系統(tǒng)。本系統(tǒng)明文許可用于多用戶環(huán)境或網(wǎng)絡(luò)系統(tǒng)上;或者,使用本系統(tǒng)的每一節(jié)點及終端都已購買使用許可。3.其它權(quán)利和限制的說明 1)對本系統(tǒng)再次轉(zhuǎn)讓許可;
2)對本系統(tǒng)進行逆向工程、反匯編或解體拆卸;
3)拷貝或轉(zhuǎn)交本系統(tǒng)的全部或部分,但本協(xié)議中明文規(guī)定的除外。
4)您將本系統(tǒng)或拷貝的全部或局部轉(zhuǎn)讓給另一使用方之時,您的許可權(quán)即自行終止。4.本系統(tǒng)的版權(quán)和所有權(quán):
本系統(tǒng)及其所有拷貝的名稱,與光盤上或本系統(tǒng)中注明的公司同在。本系統(tǒng)及文檔享有版權(quán),并受國家版權(quán)法及國際公約條款的保護。您不可以從本軟件中去掉其版權(quán)聲明;并保證為本系統(tǒng)的拷貝(本部或部分)復(fù)制版權(quán)聲明。您同意制止以任何形式非法拷貝本系統(tǒng)及文檔。5.有限保證
如果本“軟件產(chǎn)品”注明為基本版,則該軟件的某些功能按照億通暢聯(lián)公司保證本軟件所公布的功能和規(guī)格,使用期限為期半年(或根據(jù)銷售合同規(guī)定的時間期限),使用期限到期后,該部分功能的使用將受到限制。說明:如果您購買了該軟件產(chǎn)品的“企業(yè)激活碼”,您對“企業(yè)激活碼”的使用應(yīng)受該最終用戶軟件授權(quán)協(xié)議中的條款和條件的約束。6.售后擔(dān)保:
1)億通暢聯(lián)科技擔(dān)保,在正常使用的情況下,自售出之日起九十天內(nèi),其軟件載體無材料或工藝缺陷。經(jīng)驗證確有缺陷時,本公司的全部責(zé)任就是退換其軟件載體;也是給您的唯一補償。
用友遠程服務(wù)系統(tǒng)V1.02
目錄
1.歡迎使用用友遠程服務(wù)系統(tǒng).........................................................................................................................................2 1.1概要介紹..................................................................................................................................................................2 1.2運行環(huán)境..................................................................................................................................................................2 1.3設(shè)置..........................................................................................................................................................................2 1.4.注冊.........................................................................................................................................................................4 2.用友遠程服務(wù)系統(tǒng)使用說明.......................................................................................................................................7 2.1.安裝與卸載.............................................................................................................................................................7 2.2.用友遠程服務(wù)系統(tǒng)主界面...................................................................................................................................7 2.3.系統(tǒng)服務(wù)主界面.....................................................................................................................................................8 2.4.與工程師進行會話.................................................................................................................................................9 2.6.消息中心...............................................................................................................................................................14 2.7 設(shè)置在線狀態(tài).......................................................................................................................................................15 2.8.軟件自動更新.......................................................................................................................................................15 3.技術(shù)支持信息...............................................................................................................................................................15
用友遠程服務(wù)系統(tǒng)V1.02
圖:基本設(shè)置
在上述界面內(nèi),用戶可進行基本信息修改及用戶密碼設(shè)置。
注冊
詳細內(nèi)容可參考下一節(jié)的內(nèi)容。
? 網(wǎng)絡(luò)設(shè)置
網(wǎng)絡(luò)設(shè)置主要是讓通過代理上網(wǎng)的用戶可以連接到用友遠程服務(wù)系統(tǒng)的服務(wù)器。用戶在進行代理設(shè)置時要根據(jù)自己的上網(wǎng)方式來選擇。
在您登陸系統(tǒng)之前,請先對本軟件的網(wǎng)絡(luò)進行設(shè)置:
無論在何種網(wǎng)絡(luò)環(huán)境中,請確認您的計算機可以訪問公網(wǎng)主機的 8000,8001及8008端口。如果您的網(wǎng)絡(luò)內(nèi)沒有硬件防火墻,或者軟件防火墻則不必進行網(wǎng)絡(luò)設(shè)置。如果您的網(wǎng)絡(luò)內(nèi)有防火墻,但沒有對公網(wǎng)訪問進行限制,則也不必進行網(wǎng)絡(luò)設(shè)置。如果您的網(wǎng)絡(luò)需要通過代理才能訪問到外網(wǎng)主機及端口,則需要點擊“網(wǎng)絡(luò)選項”進行設(shè)置。
用友遠程服務(wù)系統(tǒng)V1.02
輸入后企業(yè)碼后,點擊確定,出現(xiàn)如下用戶注冊信息。
輸入自定義的注冊登陸用戶和密碼后,點擊注冊即完成 在線用戶 的注冊。
用友遠程服務(wù)系統(tǒng)V1.02
2.用友遠程服務(wù)系統(tǒng)使用說明
2.1.安裝與卸載
(一)安裝用友遠程服務(wù)系統(tǒng)
運行用友遠程服務(wù)系統(tǒng)的安裝程序,找到軟件安裝包
雙擊此安裝文件進行企業(yè)端遠程服務(wù)安裝。按安裝向?qū)У奶崾具M行操作安裝完成后,因為您是第一次使用本企業(yè)端軟件,需要進行軟件注冊,注冊流程詳見1.4章節(jié)的內(nèi)容。軟件安裝成功后,會在系統(tǒng)的開始->程序內(nèi)建立程序項,也會在桌面及快速啟動欄內(nèi)創(chuàng)建軟件快捷方式,通過此快捷方式的點擊,用戶可很容易的打開軟件。
(二)卸載用友遠程服務(wù)系統(tǒng)
卸載用友遠程服務(wù)系統(tǒng)的方法有以下兩種:(1).從Windows控制面板卸載:
打開Windows控制面板->添加/刪除程序,然后選中[用友遠程服務(wù)系統(tǒng)],單擊刪除即可。(2).從程序欄內(nèi)執(zhí)行遠程服務(wù)卸載:
打開 開始->所有程序->用友遠程服務(wù)系統(tǒng)卸載,按向?qū)У奶崾具M行操作,即可將本軟件從系統(tǒng)內(nèi)卸載。
2.2.用友遠程服務(wù)系統(tǒng)主界面
首先通過開始的程序菜單或其它方式打開用友遠程服務(wù)系統(tǒng)的主程序,進入用友遠程服務(wù)系統(tǒng)的客戶端主界面,您就可以正常使用了,如下圖:
用友遠程服務(wù)系統(tǒng)V1.02
企業(yè)用戶登陸后,可在主服務(wù)界面內(nèi)選擇我的產(chǎn)品,選擇問題種類,選擇模塊范圍(可選),并點擊
按鈕開始呼叫遠端工程師。點擊后系統(tǒng)自動為您呼叫合適的工程師,呼叫成功,則您可以和遠端工程師通過文字會話、文件傳輸、遠程桌面接管等方式,來解決您當(dāng)前的問題及溝通解決問題的方法。
2.4.與工程師進行會話
呼叫工程師成功后,您可以在如下界面內(nèi)與工程師進行溝通交流。
用友遠程服務(wù)系統(tǒng)V1.02 在用友遠程服務(wù)系統(tǒng)的主界面上單擊
按鈕,出現(xiàn)如下安全警告界面;
圖:請求遠程服務(wù)
企業(yè)用戶點擊 是 按鈕,則表示用戶同意請求遠程桌面請求,此時工程師端點擊接受后,即可開始進行遠程協(xié)助會話。
點擊 按鈕,可以瀏覽文件,將文件發(fā)送到對方,也可以將文件直接拖拽到文字編輯框內(nèi)來實現(xiàn)文件發(fā)送。
用友遠程服務(wù)系統(tǒng)V1.02
在彈出的對話框內(nèi),企業(yè)用戶可寫入投訴信息,點擊確認按鈕后,系統(tǒng)將此信息自動發(fā)送到用友相關(guān)客服部門進行處理。
用友遠程服務(wù)系統(tǒng)V1.02 2.7 設(shè)置在線狀態(tài)
操作員可通過點擊服務(wù)主界面的 狀態(tài) 菜單進行狀態(tài)的修改。
當(dāng)在會話狀態(tài)的企業(yè)端用戶設(shè)置了狀態(tài)信息后,對端工程師會話窗口內(nèi)會顯示該用戶的狀態(tài)。
2.8.軟件自動更新
用友遠程服務(wù)系統(tǒng)提供網(wǎng)絡(luò)自動更新功能,可以及時對產(chǎn)品升級,可以增強軟件的功能,使產(chǎn)品功能更加完善。自動更新方式:
(1).當(dāng)用戶登陸到系統(tǒng)后,系統(tǒng)自動驗證該軟件版本是否為最新,并給出是否更新新版軟件的提示;(2).用戶可在服務(wù)主界面的 用友鏈接 頁面內(nèi),點擊 更新最新版本 鏈接,來進行自動下載更新。
如果您在升級過程中遇到什么問題請與我們聯(lián)系,詳細聯(lián)系方式請參閱技術(shù)支持信息。
3.技術(shù)支持信息
如果在使用的過程中遇到問題,請及時與我們聯(lián)系!公司名稱:用友軟件股份有限公司 地址: 郵編:100085 電話:
第三篇:怎么寫軟件需求說明書范文
怎么寫軟件需求說明書
關(guān)鍵字:軟件需求 說明書
軟件需求說明書
1.引言
1.1 項目名稱
1.2 項目背景和內(nèi)容概要
(項目的委托單位、開發(fā)單位、主管部門、與其它項目的關(guān)系,與其他機構(gòu)的關(guān)系等)
1.3 相關(guān)資料、縮略語、定義
(相關(guān)項目計劃、合同及上級機關(guān)批文,引用的文件、采用的標(biāo)準(zhǔn)等)
(縮寫詞和名詞定義)
2.任務(wù)概述
2.1 目標(biāo)
(項目的開發(fā)目標(biāo)和應(yīng)用目標(biāo)。如果是其他系統(tǒng)的一部分,則說明其關(guān)系)
2.2 范圍
(包含的業(yè)務(wù),不包含的業(yè)務(wù))
2.3 假定條件與約束限制
(盡量列出開展本項目的假定和約束,例如:經(jīng)費限制,開發(fā)期限,設(shè)備條件,用戶現(xiàn)場環(huán)境準(zhǔn)備等)
3.業(yè)務(wù)流程
4.數(shù)據(jù)描述
4.1 原始數(shù)據(jù)描述
a.靜態(tài)數(shù)據(jù)
b.動態(tài)數(shù)據(jù)
4.2 數(shù)據(jù)流向圖
4.3 數(shù)據(jù)概念模型和描述
5.功能需求
5.1 功能描述
6.界面要求
6.1報表格式
6.2圖形要求
6.3輸入輸出要求
7.接口要求
(描述與本系統(tǒng)相連的系統(tǒng)的接口的數(shù)據(jù)格式,數(shù)據(jù)交換協(xié)議,接口功能等)
8.性能需求
8.1數(shù)據(jù)精確度
(例如,數(shù)據(jù)內(nèi)部精度,外部顯示精度)
8.2數(shù)據(jù)量
8.3時間特性要求
(根據(jù)所開發(fā)系統(tǒng)的特點,規(guī)定系統(tǒng)對時間的特性的要求。例如: 系統(tǒng)響應(yīng)時間、界面更新處理時間、數(shù)據(jù)轉(zhuǎn)換與傳輸時間)
9.運行環(huán)境需求
9.1網(wǎng)絡(luò)和硬件設(shè)備平臺
(網(wǎng)絡(luò)拓撲圖及設(shè)備類型描述)
10.操作系統(tǒng)平臺
數(shù)據(jù)庫系統(tǒng)平臺
10.1編程工具
10.2其它支撐軟件
11.其它專門需求
11.1安裝和操作
11.2安全保密
11.3維護服務(wù)
第四篇:如何寫軟件項目需求說明書
如何寫軟件項目需求說明書
進入軟件開發(fā)行業(yè)也有一段時間了,大大小小項目也接觸了一些,對于怎么寫好項目需求文檔做一下總結(jié),發(fā)表一下自己的看法。1 獲取需求:
作為需求方也就是甲方,通過語言描述或文檔的方式將需求(系統(tǒng)需要提供的功能)提交給開發(fā)人員(需求分析人員)。
獲得需求的方式可以有多種多樣:電話詢問、現(xiàn)場考察、聆聽用戶講解、閱讀用戶編制的相關(guān)文件(如招標(biāo)書),其實這些方法都是GET方式,我們可以通過以下兩類技術(shù)手段來達到:GET(獲取)和PUSH(引導(dǎo)、反饋、激發(fā))相互結(jié)合的方式來得到我們真正的需求,而這兩個過程都是必須交互進行的,一般我們可以篩選一名非常有經(jīng)驗(包括談判技巧、深厚的業(yè)務(wù)和技術(shù)背景、人緣很好、勤奮努力)的人士擔(dān)任需求工程師,長期在客戶那里工作。2 需求分析人員
(1)根據(jù)客戶提供的文檔或語言描述,將需求按功能劃分,以用例圖的方式表達系統(tǒng)提供的功能模塊及功能模塊之間的關(guān)系,完成用例圖后與客戶確認大的功能模塊,并對每個功能模塊做進一步的溝通詳細記錄用戶所提供的關(guān)鍵性的描述,此過程需要系統(tǒng)分析人員對客戶進行引導(dǎo)。
(2)對每個功能模塊進行詳細分析與描述,具體信息包括:用戶角色、功能說描述、IPO的方式進行描述(即輸入項、輸出項、處理)、要提供必要的功能說明,如果使文檔更加直觀,更容易讓客戶理解,可以用UI的方式表達輸入輸出,配合必要的描述,這樣對于客戶更加容易理解,需要與客戶進行大量的溝通確認。
(3)編寫數(shù)據(jù)字典:在需求階段,很難使團隊的思路一致,建立一個合適的機制是完全必要的,這就是數(shù)據(jù)字典,數(shù)據(jù)字典是對系統(tǒng)用到的所有數(shù)據(jù)項和結(jié)構(gòu)的定義,以確保開發(fā)人員使用統(tǒng)一的數(shù)據(jù)定義。在需求階段,數(shù)據(jù)字典至少應(yīng)定義客戶數(shù)據(jù)項以確??蛻襞c開發(fā)小組是使用一致的定義和術(shù)語。分析和設(shè)計工具通常包括數(shù)據(jù)字典組件。
(4)關(guān)于文檔具體表述的格式與形式,要根據(jù)所要表達的功能來確定,最重要的是把事情描述清楚,這事最終的目的;
(5)需求文檔確定后,設(shè)計人員根據(jù)這份需求文檔進行系統(tǒng)的設(shè)計工作了。
第五篇:如何編寫高質(zhì)量“軟件需求說明書”.doc
如何編寫高質(zhì)量“軟件需求說明書”2003-01-27· · ··天極論壇 2 下一頁
你的工程應(yīng)該有個好的起點。一個小組要帶領(lǐng)客戶進入需求啟發(fā)階段而且你要寫軟件需求說明書。這份說明有些大,但客戶會很重視,所以說明必須得到贊同。
現(xiàn)在你正在設(shè)計其中的一個特性,已經(jīng)發(fā)現(xiàn)了需求的一些問題。你可以用多種不同的方式解釋需求15;需求9 的說明正好與需求21相反,你因該相信哪一個?需求24非常含糊,你根本不明白它的意思;你不得不花上一個小時與2位開發(fā)人員討論需求30,只因為你們對 其各有各的理解;并且,唯一能夠澄清這些問題的客戶沒有給你們答復(fù)。你被迫破解眾多需求的含義,并且你能預(yù)料到,如果你錯了,你要做大量的重復(fù)工作。
許多軟件需求說明書(SRS)寫得非常糟糕。任何產(chǎn)品的質(zhì)量需要其原始材料的質(zhì)量保證,糟糕的軟件需求說明書不可能產(chǎn)出優(yōu)秀的軟件。不幸的是,幾乎沒有開發(fā)人員受過與需求的抽象、分析、文檔、質(zhì)檢有關(guān)的教育。而且,沒有非常多的好需求可以借鑒學(xué)習(xí),部分原因是很少有工程可以找到一個好的借鑒,其 他原因是公司不愿意將其產(chǎn)品說明書放在公共區(qū)域。
這篇文章描述了高質(zhì)量需求敘述和說明的幾個特性(特點)。我們將用這些觀點檢查一些有缺陷的需求,帶著痛楚重新編寫。而且我會談一些如何編寫好 的需求的提示。你也許想通過這些質(zhì)量標(biāo)準(zhǔn)評估你的工程需求。對于修訂,也許遲了,但你會學(xué)到一些有用的東西,并幫助你的小組在下次編寫出更好的需求。
不要期望能夠編寫出一份能體現(xiàn)需求應(yīng)具備的所有特性的SRS。無論你怎么細化、分析、評論和優(yōu)化需求,都不可能達到完美。但是,如果你牢記這些特性,你就會編寫出更好的需求,生產(chǎn)出更好的產(chǎn)品。
高質(zhì)量需求敘述的特性
我們?nèi)绾螐囊恍┯袉栴}的需求中分辨出好的軟件需求?這一節(jié)將分別介紹需求敘述應(yīng)體現(xiàn)的6個特性,下一節(jié)將從整體上介紹SRS文檔應(yīng)具備的特性。判斷每個需求是否具備應(yīng)有的特性的一種方式是由持有不同觀點的工程資金管理人所作的正規(guī)檢查。另一種有力的方法是在編寫代碼前依據(jù)需求編寫測試例子。測試 例子能夠明確顯現(xiàn)在需求中描述的產(chǎn)品行為(特性),能夠顯現(xiàn)缺陷、冗余和含糊之處。
正確:每個需求必須精確描述要交付的功能。正確性依據(jù)于需求的來源,如真實的客戶或高級別的系統(tǒng)需求說明書。一個軟件需求與其對應(yīng)的系統(tǒng)需求說明書相抵觸是不正確的(當(dāng)然,系統(tǒng)需求說明書本身可能不正確)。
只有用戶的代表能夠決定用戶需求的正確性,這就是為什么在檢查需求時,要包括他們或他們的代理的關(guān)鍵所在。不包括用戶的需求檢查就會導(dǎo)致開發(fā)人員的:“這是沒意義的”,“這可能是他們的意思”等眾所周知的猜測。
可行性:在已知的能力、有限的系統(tǒng)及其環(huán)境中每個需求必須是可實現(xiàn)的。為了避免需求的不可行性,在需求分析階段應(yīng)該有一個開發(fā)人員參與,在抽象階段應(yīng)該有市場人員參與。這個開發(fā)人員應(yīng)能檢查在技術(shù)上什么能做什么不能做,哪些需要需要額外的付出或者和其他的權(quán)衡。
必要性:每個需求應(yīng)載明什么是客戶確實需要的,什么要順應(yīng)于外部的需求,接口或標(biāo)準(zhǔn)。每個需求源于你認可、具有權(quán)說明需求的原始資料,這是考慮 必需的另外情形(譯注,此句翻譯不順,請參照原文:Another way to think of “necessary” is that each requirement originated from a source you recognize as having the authority to specify requirements)。跟蹤每個需求回溯到出處,如用例,系統(tǒng)需求,規(guī)章,或來自其他用戶的意見。如果你不能標(biāo)識出處,可能需求只是個鍍金的例子,沒有真正的必須。
優(yōu)先權(quán):為了表明在一個詳細的產(chǎn)品版本中應(yīng)包含哪些要點,需要為每個需求,特征,或用例分配實現(xiàn)的優(yōu)先權(quán)??蛻艋蚱浯矶紤?yīng)有強烈的責(zé)任建立優(yōu) 先權(quán)。如果所有的需求都被視為同等重要,那么由于在開發(fā)中,預(yù)算削減,計劃超時或組員的離開導(dǎo)致新的需求時,項目經(jīng)理將不能起到作用。優(yōu)先權(quán)的作用是提供給客戶的價值,實現(xiàn)的相關(guān)費用,實現(xiàn)相關(guān)聯(lián)的有關(guān)技術(shù)風(fēng)險。
我是用3種級別的優(yōu)先權(quán):高優(yōu)先權(quán)表明需求必須體現(xiàn)在下一個產(chǎn)品版本中,中優(yōu)先權(quán)表明需求是必須的,但是如果需要可以推遲到晚一些的產(chǎn)品版本中,低優(yōu)先權(quán)表明有它很好,但我們必須認識到如果沒有充足的時間或資源,它可以被放棄掉。
明確:需求敘述的讀者應(yīng)只能從其得到唯一的解釋說明,同樣,一個需求的多個讀者也應(yīng)達成共識。自然語言極易導(dǎo)致含糊。要避免使用一些對于SRS 作者很清楚但對于讀者不清楚的主觀詞匯,如:用戶友好性,容易,簡單,快速,有效,幾個,藝術(shù)級,改善的,最大,最小等等。每寫一個需要都應(yīng)簡潔,簡單,直觀的采用用戶熟知的語言,不要采用計算機術(shù)語。檢查需求模糊的有效方式包括需求說明書的正規(guī)檢查,根據(jù)需求寫測試,建立用戶的假想來說明產(chǎn)品某個特定部 分預(yù)期的特性。
可證實:看你是否能夠做出測試計劃或其他驗證方式,如檢查和實證,來決定在產(chǎn)品中每個需求是否正確的實現(xiàn)。如果需求是不可驗證的,決定需求是不 是正確的實現(xiàn)就成了判斷的事。需求之間不一致,不可行,不明確也能導(dǎo)致不可證實。任何需求如果說產(chǎn)品將要支持什么也是不可證實的。
高質(zhì)量需求說明的特征
一個完整的SRS不僅是包括長長的功能性需求列表,還包括外部接口描述和一些諸如質(zhì)量屬性,期望性能的非功能性需求。下面描述了高質(zhì)量的SRS的一些特性。
完整:不應(yīng)該遺漏要求和必需的信息。完整性也是一個需求應(yīng)具備的。發(fā)現(xiàn)缺少的信息很難,因為根本不存在。在SRS中將需求以分層目錄方式組織,將幫助評審人員理解功能性描述的結(jié)構(gòu),使他們很容易指出遺失的東西。
在需求抽象時,相對于系統(tǒng)功能,你過多的注意用戶的業(yè)務(wù),將導(dǎo)致在需求的全局觀和引進不是真正必需的需求上顯得不足。在需求抽象上,應(yīng)用用例方法會發(fā)揮很好的作用。能夠從不同角度察看需求的圖形分析模型也可以檢查出不完整性。
如果你知道已缺少一些信息,使用TBD(to be determined)標(biāo)準(zhǔn)標(biāo)志可以突出這些缺陷,當(dāng)你在構(gòu)建產(chǎn)品的相關(guān)部分時,就可以從一個給定的需求集中解決所有的缺陷。
一致性:一致性需求就是不要于其他的軟件需求或高級別的系統(tǒng)(商業(yè))需求發(fā)生沖突。需求中的不一致必須在開發(fā)開始前得到解決。只有經(jīng)過調(diào)研才能確定哪些是正確的。修改需求時一定要謹慎,如果只審定修改的部分,沒有審定于修改相關(guān)的部分,就可能導(dǎo)致不一致性。
可修改性:當(dāng)每個需求的要求修改了或維護其歷史更改時,你必須能夠?qū)彾⊿RS。也就是說每個需求必須相對于其他需求有其單獨的標(biāo)示和分開的說明,便于清晰的查閱。通過良好的組織可以使需求易于修改,如:將相關(guān)的需求分組,建立目錄表,索引,以及前后參考(照)。
可追蹤:你應(yīng)能將一個軟件與其原始材料相對應(yīng),如高級系統(tǒng)需求,用例,用戶的提議等。也能夠?qū)④浖枨笈c設(shè)計元素,源代碼,用于構(gòu)造實現(xiàn)和驗證需求的測試相對應(yīng)??勺粉櫟男枨髴?yīng)該具有獨立標(biāo)示,細密和結(jié)構(gòu)化的編寫,不應(yīng)過大,不應(yīng)是敘述性的文字和公告式的列表。
需求質(zhì)量的評審
這些有關(guān)需求質(zhì)量的特性的描述在理論上都是非常好的,但一個好的需求到底是個什么樣子的呢?為了體現(xiàn)得更切合實際,我們做個小練習(xí)。下面有幾個 從實際的工程選出的需求,依據(jù)上面的質(zhì)量標(biāo)準(zhǔn),評估每個需求,看看有什么問題,然后用更好的方式重寫。我將對每個例子都提出自己的分析和改進的建議。也歡 迎你提出不同的見解。我所占優(yōu)的只是我知道每個需求的出處。因為你我都不是真正的客戶,我們只能猜測每個需求的意圖。
例1.“產(chǎn)品應(yīng)在不少于每60秒的正常周期內(nèi)提供狀態(tài)信息”
這個需求是不完整的:狀態(tài)信息是什么,如何顯示給用戶。這個需 求有幾處含糊。我們在談?wù)摦a(chǎn)品的哪部分?狀態(tài)信息間隔真的假定為不少于60秒?,甚者每10年顯示一條新的狀態(tài)信息也可以?也許它的意圖是消息間隔不應(yīng)超 過60秒,那么1毫秒是不是太短?“每”這個詞導(dǎo)致了不確定性。問題的后果,就是需求的不可證實。
彌補缺陷,重寫需求的一種方法:
1、狀態(tài)信息
1.1后臺任務(wù)管理器因該以誤差上下不超過10秒的60秒間隔,在用戶界面的指定位置顯示狀態(tài)信息
1.2如果后臺進程處理正常,那么應(yīng)該顯示任務(wù)已完成的百分數(shù)/比
1.3任務(wù)完成時,應(yīng)顯示相關(guān)的信息
1.4后臺任務(wù)出錯應(yīng)該顯示錯誤信息
為了分別測試和追蹤,我將其分成了多個需求。如果將幾個需求串接在一節(jié)中,在構(gòu)造和測試時就很容易漏掉一個。
例2.“產(chǎn)品應(yīng)瞬間在顯示和隱藏不可打印字符間切換”
計算機在瞬間不能做任何事,所以這個需求不切實可行。它的不完整性 表現(xiàn)在沒有聲明觸發(fā)狀態(tài)切換的條件。軟件要在某些條件下更改自己?或者用戶為了模仿更改要做一些動作?而且,在文檔中改變顯示的范圍是多大:選中的文本,整個的文檔,或其他的?這也是個模糊的問題。不可打印字符合隱藏字符一樣嗎?或者是一些屬性標(biāo)志或一些控制字符?問題的后果,就是需求的不可證實。
象這樣編寫需求也許更好一些:“用戶能夠在一個由特定觸發(fā)條件激活處于編輯的文檔中在顯示和隱藏所有HTML標(biāo)記間切換”?,F(xiàn)在就很清楚,不可 打印字符是HTML標(biāo)記。由于沒有定義觸發(fā)條件,需求對設(shè)計沒有約束力。只有設(shè)計人員選定了觸發(fā)條件后,你才能編寫測試驗證觸發(fā)的正確操作。
例3.“HTML分析器可以產(chǎn)生HTML標(biāo)記錯誤報告,幫助HTML入門者快速解決錯誤”。單詞“快速”使其模糊,沒
有加進錯誤報告的定義也是其部完整。我不知道,你怎么驗證這個需求。找一個自稱為HTML的入門者,看看能不能根據(jù)錯誤報告快速解決錯誤?
試試這個:“HTML分析器可以產(chǎn)生一個錯誤報告,錯誤報告包含有在被分析文件中出錯的HTML文本和行號以及錯誤的描述。如果沒有錯誤,就不 會產(chǎn)生錯誤報告”。現(xiàn)在我們知道了,什么會被加到出錯報告中,但是出錯報告是個什么樣子,則留由設(shè)計人員決定。我們還指定了一個例外:如果沒有發(fā)現(xiàn)錯誤,不產(chǎn)生錯誤報告。
例4.“如果可能,主管號碼應(yīng)通過聯(lián)機校驗,而不是通過主全體主管號碼列表校驗”。真感到絕望,什么是“如果可能”:如果技術(shù)上可行?如果主全 體主管號碼列表可以聯(lián)機獲得?要避免象“應(yīng)該”的這類不確切的詞??蛻羰切枰@個功能性還是不需要。我曾看過一些需求說明書,采用諸如:應(yīng),將,應(yīng)該/
將 要等一些詞描述優(yōu)先級的細微差別。但我更喜歡用“應(yīng)”清楚的說明需求的意圖,指明優(yōu)先級。這是修改后的:系統(tǒng)應(yīng)校驗輸入的主管號碼而不通過聯(lián)機的主全體主 官號碼列表。如果在列表中沒有發(fā)現(xiàn)主管號碼,將會顯示一條錯誤信息,也不接受指令。
在理解各個已完成的糟糕需求上,開發(fā)人員將會遇到的難題是:開發(fā)人員與客戶將會在審核需求,未達成共識前發(fā)生激烈的爭論。詳細檢查大的需求文檔 不是一件輕松的事情。我清楚有人做過,而且他們花在檢查上的每一分鐘都是值得的。相對于開發(fā)階段和用戶的抱怨電話,在這個階段修補缺陷是便宜的,編寫質(zhì)量需求的方針
編寫優(yōu)秀的需求是沒有公式化的方法的。這需要大量的經(jīng)驗,要從你在過去的文檔中發(fā)現(xiàn)的問題學(xué)習(xí)。請在組織軟件需求文檔時,嚴格遵從這些方針。
句子和段落要短。采用主動語氣。使用正確的語法,拼寫,標(biāo)點。使用術(shù)語,要保持一致性,并在術(shù)語表或數(shù)據(jù)字典中定義它們
要看需求是否被有效的定義,可以以開發(fā)人員的觀點看看。在內(nèi)心將“當(dāng)你們做完了找我”這句加到文檔尾部,看看能不能是你緊張起來。換句話說,你 是否需要SRS的編寫者的額外解釋幫助開發(fā)人員很好的理解需求,以便于設(shè)計和實現(xiàn)?如果是的話,在繼續(xù)工作前,需求還需要細化。
需求編寫者還要努力正確地把握細化程度。要避免包含多個需求的長的敘述段落。有幫助的提示是編寫?yīng)毩⒌目蓽y試的需求。如果你認為一小部分測試可以驗證一個需求的正確,那么它已經(jīng)正確的細化了。如果你預(yù)想到多種不同類的測試,幾個需求可能已擠到了一起,需要拆分開。
密切關(guān)注多個需求合成了單個需求。一個需求中的連接詞“和”/“或”建議幾個需求合并。不要在一個需求中使用“和”/“或”。
通篇文檔細節(jié)上要保持一致。我曾看見過多個需求說明書前后不一致。如:“對于紅色合法的顏色代碼應(yīng)是R”及“對于綠色合法的顏色代碼應(yīng)是G”就有可以以分散的需求分離開,而“產(chǎn)品應(yīng)能對來自語音編輯指示做出反應(yīng)”應(yīng)作為一個子系統(tǒng),不應(yīng)作為單個的功能性需求。
避免在SRS中過多的申述需求。在多處包含相同的需求可以使文檔更易于閱讀,但也會給文檔的維護增加困難。文檔的多份文本要在同一時間內(nèi)全部更新,避免不一致性。
如果你遵從了這些方針,你能夠盡早地經(jīng)常正式或非正式的審查需求,這些需求對于產(chǎn)品的構(gòu)造,系統(tǒng)測試以及最后的客戶滿意,都會成為好的奠基石。并且要記住,沒有高質(zhì)量的需求,軟件就象一盒巧克力,你永遠不知道你會得到什么。