軟件需求說明書編寫規(guī)范

引言 11.1編寫目的 11.2范圍 11.3定義 11.4參考資料 12項目概述 12.1產(chǎn)品描述 12.2產(chǎn)品功能 22.3用戶特點 22.4一般約束 22.5假設和依據(jù) 33具體需求 33.1功能需求 33.1.1功能需求1 33.1.2功能需求2 43.1.n功能需求n 43.2外部接口需求 43.2.1用戶接口 43.2.2硬件接口 53.2.3軟件接口 53.2.4通信接口 53.3性能需求 53.4設計約束 63.4.1其它標準的約束 63.4.2硬件的限制 63.5屬性 63.5.1可用性 63.5.2安全性 73.5.3可維護性 73.5.4可轉(zhuǎn)移＼轉(zhuǎn)換性 73.5.5警告 73.6其它需求 73.6.1數(shù)據(jù)庫 73.6.2操作 83.6.3場合適應性需求 84附錄 81引言1.1編寫目的詳細列出用戶對該軟件期望實現(xiàn)的功能。1.2范圍Linux下的FlowerMail郵件系統(tǒng)是由北京理工大學實訓小組受NEUSOFT委托為其開發(fā)的一套局域網(wǎng)內(nèi)部的郵件通信系統(tǒng)。公司使用這套系統(tǒng)后，能夠使日常的信息交流，文件傳遞更加便捷，從而使工作效率得到了極大的提升，增加了員工之間的友好交流，增進了友誼。實訓小組作為這款軟件的開發(fā)商，提高了自己編寫程序的能力。1.3定義//1.4參考資料a、Linux系統(tǒng)下郵件系統(tǒng)項目要求說明書2項目概述2.1產(chǎn)品描述軟件開發(fā)是為了解局域網(wǎng)下公司員工之間郵件交流困難的問題，預期將實現(xiàn)局域網(wǎng)下郵件的收發(fā)，存儲等功能方便員工相互之間的交流，作用范圍是公司局域網(wǎng)上的所有員工。該軟件是基于Linux系統(tǒng)下的獨立的郵件收發(fā)系統(tǒng)。2.2產(chǎn)品功能FlowerMail郵件系統(tǒng)的功能主要包括：郵件的接受與存儲，郵件的編寫與發(fā)送，郵件的閱讀轉(zhuǎn)發(fā)，郵件的刪除與恢復等功能。2.3用戶特點用戶主要是局域網(wǎng)內(nèi)的員工，主要使用的功能是郵件的編寫發(fā)送，接受閱讀功能，每天使用的頻率大概為沒人3-5次，因此有新郵件時需要有及時明顯的消息提醒。2.4一般約束1、全中文操作界面，簡潔方便用戶使用2、適用于Linux各種版本的計算機3、能夠添加各種格式的附件4、使用c語言編寫5、使用安全的通信協(xié)議，如XXX6、使用一人一賬號實名注冊，每個身份信息能夠注冊一個賬號2.5假設和依據(jù)本系統(tǒng)需要有完整的局域網(wǎng)，依賴于mysql數(shù)據(jù)庫管理系統(tǒng)3具體需求3.1功能需求3.1.1功能需求1郵件系統(tǒng)注冊功能首先打開郵件登陸界面，點擊注冊按鈕進入新用戶注冊界面，需要輸入用戶名，8-14英文字母和阿拉伯數(shù)字及下劃線構成，密碼由8-14位數(shù)字字母及下劃線構成，再次輸入密碼同密碼，手機號輸入11位數(shù)字，填寫完畢后點擊提交按鈕系統(tǒng)開始檢測輸入格式長度是否合法，經(jīng)過數(shù)據(jù)庫系統(tǒng)檢測用戶名手機號是否唄注冊，如果所有檢測都經(jīng)過則提示注冊成功，如果檢測出現(xiàn)問題則提示注冊失敗返回問題。用戶能夠點擊重置按鈕，清空已經(jīng)填寫的全部內(nèi)容。注冊成功或者失敗都會彈出提示窗口告訴用戶。如果點擊提交時丟失網(wǎng)絡連接，則提示失去網(wǎng)絡連接注冊失敗并返回主頁面。3.1.2功能需求2郵件系統(tǒng)新建郵件功能首先點擊主頁面上的新建按鈕進入編寫新郵件的界面，需要輸入發(fā)件人，收件人，主題，正文，能夠添加附件或者更改字體大小顏色格式等，輸入完成后點擊發(fā)送按鈕，系統(tǒng)開始檢測輸入的發(fā)件人，收件人格式是否正確，如果都正確發(fā)送郵件，發(fā)送成功或者失敗給出提示窗口并返回主界面。如果編寫過程中意外退出或者點擊發(fā)送時失去網(wǎng)絡，則將編寫的郵件存入收件箱，提示發(fā)送失敗。3.1.n功能需求3郵件系統(tǒng)收件箱功能在主界面上點擊收件箱進入收件箱界面，這里主要保存了收到的郵件和未讀的郵件，未讀郵件會有標志。經(jīng)過收件箱功能用戶能夠方便管理收到的郵件，對郵件進行批量的刪除，已讀操作，單擊某個郵件能夠讀取郵件內(nèi)容，并能夠?qū)︵]件進行轉(zhuǎn)發(fā)，刪除操作，搜索一欄填寫用戶需要搜索的關鍵詞，系統(tǒng)在下方已經(jīng)收到的郵件中搜索包含關鍵詞的主題，發(fā)件人的郵件并列表表示出來。3.2外部接口需求3.2.1用戶接口提供用戶使用軟件產(chǎn)品時的接口需求。例如，如果系統(tǒng)的用戶經(jīng)過顯示終端進行操作，就必須指定如下要求：對屏幕格式的要求；報表或菜單的頁面打印格式和內(nèi)容；輸入輸出的相對時間；程序功能鍵的可用性。3.2.2硬件接口要指出軟件產(chǎn)品和系統(tǒng)硬部件之間每一個接口的邏輯特點。還可能包括如下事宜：支撐什么樣的設備，如何支撐這些設備，有何約定。3.2.3軟件接口在此要指定需使用的其它軟件產(chǎn)品（例如，數(shù)據(jù)管理系統(tǒng)、操作系統(tǒng)或數(shù)學軟件包），以及同其它應用系統(tǒng)之間的接口。對每一個所需的軟件產(chǎn)品，要提供如下內(nèi)容：名字；助記符；規(guī)格說明號；版本號；來源。對于每一個接口，這部分應說明與軟件產(chǎn)品相關的接口軟件的目的，并根據(jù)信息的內(nèi)容和格式定義接口，但不必詳細描述任何已有完整文件的接口，只要引用定義該接口的文件即可。3.2.4通信接口指定各種通信接口。例如，局部網(wǎng)絡的協(xié)議等等。3.3性能需求從整體來說，本條應具體說明軟件、或人與軟件交互的靜態(tài)或動態(tài)數(shù)值需求。靜態(tài)數(shù)值需求可能包括：支持的終端數(shù)；支持并行操作的用戶數(shù)；處理的文卷和記錄數(shù)；表和文卷的大小。動態(tài)數(shù)值需求可能包括：欲處理的事務和任務的數(shù)量，以及在正常情況下和峰值工作條件下一定時間周期中處理的數(shù)據(jù)總量。所有這些需求都必須用能夠度量的術語來敘述。例如，95％的事務必須在小于1s時間內(nèi)處理完，不然，操作員將不等待處理的完成。3.4設計約束設計約束受其它標準、硬件限制等方面的影響。3.4.1其它標準的約束本項將指定由現(xiàn)有的標準或規(guī)則派生的要求。例如：報表格式；數(shù)據(jù)命名；財務處理；審計追蹤，等等。3.4.2硬件的限制本項包括在各種硬件約束下運行的軟件要求，例如，應該包括：硬件配置的特點（接口數(shù)，指令系統(tǒng)等）；內(nèi)存儲器和輔助存儲器的容量。3.5屬性在軟件的需求之中有若干個屬性，以下指出其中的幾個（注意：對這些決不應理解為是一個完整的清單）。3.5.1可用性能夠指定一些因素，如檢查點、恢復和再啟動等，以保證整個系統(tǒng)有一個確定的可用性級別。3.5.2安全性指的是保護軟件的要素，以防止各種非法的訪問、使用、修改、破壞或者泄密。這個領域的具體需求必須包括：利用可靠的密碼技術；掌握特定的記錄或歷史數(shù)據(jù)集；給不同的模塊分配不同的功能；限定一個程序中某些區(qū)域的通信；計算臨界值的檢查和。3.5.3可維護性規(guī)定若干需求以確保軟件是可維護的。例如：軟件模塊所需要的特殊的耦合矩陣；為微型裝置指定特殊的數(shù)據(jù)＼程序分割要求。3.5.4可轉(zhuǎn)移＼轉(zhuǎn)換性規(guī)定把軟件從一種環(huán)境移植到另一種環(huán)境所要求的用戶程序，用戶接口兼容方面的約束等等。3.5.5警告指定所需屬性十分重要，它使得人們能用規(guī)定的方法去進行客觀的驗證。3.6其它需求根據(jù)軟件和用戶組織的特性等，某些需求放在下面各項中描述。3.6.1數(shù)據(jù)庫本項對作為產(chǎn)品的一部分進行開發(fā)的數(shù)據(jù)庫規(guī)定一些需求，它們可能包括：在功能需求中標識的信息類別；使用的頻率；存取能力；數(shù)據(jù)元素和文卷描述符；數(shù)據(jù)元素、記錄和文卷的關系；靜態(tài)和動態(tài)的組織；數(shù)據(jù)保存要求。注：如果使用一個現(xiàn)有的數(shù)據(jù)庫包，這個包應在“軟件接口”中命名，并在那里詳細說明其用法。3.6.2操作這里說明用戶要求的常規(guī)的和特殊的操作。在用戶組織之中各種方式的操作。例如，用戶初始化操作；交互作用操作的周期和無人操作的周期；數(shù)據(jù)處理運行功能；后援和恢復操作。注：這里的內(nèi)容有時是用戶接口的一部分。3.6.3場合適應性需求這里包括：對給定場合或相關任務或操作方式的任何數(shù)據(jù)或初始化順序的需求進行定義。例如，柵值，安全界限等等。指出場合或相關任務為特點，這里能夠被修改以使軟件適合特殊配制的要求。4附錄對一