Ⅰ 軟體測試說明書怎麼寫啊
下面這個你看下,內容有點多,部分條款按照自己公司習慣和要求修改1. 引言1.1編寫目的:編寫此文檔的目的是進一步定製軟體開發的細節問題,便於用戶與開發商協調工作.本文檔面向的讀者主要是項目委託單位的管理人員.希望能使本軟體開發工作更具體.1.2項目背景1.2.1項目委託單位:****公司1.2.2開發單位:***公司1.3定義1.4參考資料2. 任務概述2.1目標:<1> 決策支持:根據公司的要求及時提供所需報表及文件,並在適當時候對各部門領導給予銷售及進貨等方面的提示<2>提高效率:利用軟體進行管理,避免人工管理的失誤以及 延遲性,從而實現高效率的管理.2.2運行環境:<1> 硬體方面:Pentium級處理晶元1兆顯存的兼容顯卡256色,800*600的兼容顯示器標准兼容列印機<2>軟體方面: WIN95操作系統2.3條件與限制:編程用計算機一台完成期限2000/7/1無資金供給3. 數據概述數據流程圖如下: 3.1靜態數據:包括系統登錄密碼,各資料庫所在位置,系統分析原始數據3.2 動態數據:包括各資料庫內各項顯示數據,用戶登錄信息,系統時間3.3資料庫描述:人事管理資料庫:公司內人員的個人詳細信息,包括檔案信息銷售管理資料庫:當日銷售記錄及以前的銷售統計,用於銷售分析財務管理資料庫:公司內部賬目及收支情況詳表技術管理資料庫:公司所需各技術檔案的詳細記錄(包括文檔) 3.4 數據字典:<1>數據流詞條描述:1.數據流名:登錄信息來源:用戶的輸入去向:系統內部檢驗部分組成:用戶名,密碼流通量:每次登錄輸入一次2.數據流名:登錄結果來源:系統去向:用戶組成:返回信息流通量:每次登錄返回一次3.數據流名:輸入修改信息來源:用戶去向:系統判斷部分組成:根據各資料庫內容而不同流通量:依用戶輸入而定 4.數據流名:反饋信息來源:系統判斷部分去向:用戶組成:系統經判斷後發回的字元數據流通量: 依系統當前信息而定5.數據流名:識別信息來源:系統內部檢驗部分去向:系統判斷部分組成:系統各資料庫的標識信息流通量:用戶每次輸入流通一次6.數據流名:處理信息來源:系統判斷部分去向:各資料庫處理部分組成:讀取/修改標識,讀取/修改的變數名稱流通量:用戶每次輸入流通一次7.數據流名:讀取修改來源:系統判斷部分去向:系統各資料庫組成:讀取/修改標識,讀取/修改內容流通量: 用戶每次輸入流通一次<2>數據文件詞條描述:1.數據文件名:人事數據簡述:存儲人員信息數據文件組成:人員的各項信息(以CString類型為主)2.數據文件名:銷售數據簡述:存儲當日及從前的銷售記錄數據文件組成:銷售的各項信息3.數據文件名:財務數據簡述:存儲財務管理信息數據文件組成:財務管理的各項記錄4.數據文件名:技術數據簡述:存儲公司內部使用的技術檔案信息數據文件組成:技術檔案名稱,內容<3>加工邏輯詞條描述:1.加工名:檢驗簡要描述:判斷用戶的許可性輸入數據流:登錄信息輸出數據流:登錄結果加工邏輯:判斷是否與系統內部用戶信息相符合2.加工名:判斷簡要描述:判斷用戶的操作並進行相應的讀取/存儲工作 輸入數據流:輸入修改信息輸出數據流:反饋信息加工邏輯:判斷用戶的操作->調用資料庫->讀取/修改->反饋3.加工名:人事檔案管理簡要描述:對人事資料庫進行相應要求的操作,並與判斷部分交互輸入數據流:處理信息,讀取修改輸出數據流: 讀取修改, 處理信息加工邏輯:判斷用戶要讀取/修改的內容->反饋用戶所需信息4.加工名:銷售統計簡要描述:對銷售資料庫進行相應要求的操作,並與判斷部分交互輸入數據流:處理信息,讀取修改輸出數據流: 讀取修改, 處理信息加工邏輯:判斷用戶要讀取/修改的內容->反饋用戶所需信息5.加工名:財務統計簡要描述:對財務資料庫進行
推薦兩個相關的WANG 站 (本內容來自 猜字謎 http://www.caizimi.com.cn 原文地址: 謎語大全及答案 http://www.mzxl.cn)
Ⅱ 軟體著作權申請中的文檔(設計說明書或用戶手冊)怎麼寫
中國版權保護中心接收登記的文檔包含兩種:操作說明書或設計說明書。
設計說明書適合沒有界面的嵌入式軟體,插件軟體,後台運行軟體以及游戲軟體。一般包含結構圖,軟體流程圖,函數說明,模塊說明,數據介面,出錯設計等。
操作說明書適合管理類軟體,有操作界面,一般應包含登錄界面,主界面,功能界面截圖,截圖之間有相應的文字說明,能全面展示軟體的主要功能。
格式要求:
一、說明書應提交前、後各連續30頁,不足60頁的,應當全部提交。
二、說明書頁眉應標注軟體的名稱和版本號,應當與申請表中名稱完全一致,頁眉右上應標注頁碼,說明書每頁不少於30行,有圖除外,另外截圖應該清晰完整。
Ⅲ 如何編寫軟體設計說明書
文字超過1萬字,請到我提供的網址下載
1.1目的
編寫詳細設計說明書是軟體開發過程必不可少的部分,其目的是為了使開發人員在完成概要設計說明書的基礎上完成概要設計規定的各項模塊的具體實現的設計工作。
1.2背景
一、 軟體名稱
Ⅳ 軟體功能說明書怎麼寫
使 用 說 明 書
使用前請仔細閱讀本說明書
一產品簡介
本門禁控制器是專門為各類電控門鎖及保安系統而設計的它選用MICROCHIP最新CPU及存儲晶元
所有資料不會因斷電而丟失採用HOMMARD最新技術功能強大擁有四個密碼層具備超級用戶密碼
及被脅持密碼
門狀態監視輸出報警防拆一億組密碼組合被脅持密碼等完善的保安措施讓用戶更加安全開門
按鈕門鈴超級用戶可接常開或常閉鎖等強大功能讓用戶更加方便
本產品提供了一種安全自動的出入口通行管制方式是商務機構辦公室住宅小區等場所的理想裝置
二技術參數
序號 項目 指標
1 作電源 直流電壓12V10% 電流 < 0.1A
2 最大負載 報警輸出100mA 電鎖輸出5A
3 外型尺寸 116mm116mm20mm
4 重 量 160g
5 環境溫度 -2055
6 相對濕度 30%90%
三聲光指示
LED指示燈
事 件 紅 燈 綠 燈
正常狀態 每秒閃爍一次
開 鎖 亮
鍵入按鍵 亮
進入編程 亮 快速閃爍
編程確認 亮 亮
報 警 閃爍
內置蜂鳴器
事 件 說 明 鳴 音
鍵入按鍵有效 一次短鳴 嘀
輸入密碼有效 兩次短鳴 嘀嘀
輸入密碼錯誤 一次長鳴 嘀
報 警 狀 態 連續長鳴 嘀嘀嘀
四設置使用方法
1預設密碼編程密碼為9999使用密碼為1234
2進入編程狀態
按 * 編程密碼 # 進入編程狀態
3功能設置需在編程狀態下
(1)修改編程密碼
按 0 新密碼 # 重復新密碼 # 密碼位數可1-8位
(2)修改使用密碼
按 1 新密碼 # 重復新密碼 # 密碼位數可1-8位
(3)設置開門時間
按 2 X X #
注XX為00-99單位為秒出廠設置為06
(4)設置報警時間
按 3 X X #
注XX為00-99單位為分出廠設置為05
(5)設置門狀態監視
按 4 0 0 # 關閉此功能
按 4 0 1 # 開啟此功能
注門狀態監視需配合門磁開關開啟此功能時有如下兩種作用:
a.如果輸入正確密碼開門後忘了關門則蜂鳴器會鳴叫提示使用者關門
b.如果門被非法打開則會啟動報警系統同時蜂鳴器鳴叫警示
出廠設置此功能為關閉
(6)設置安全模式
按 5 0 0 # 關閉此功能
按 5 0 1 # 如連續十次輸入錯誤密碼系統鎖死10分鍾
按 5 0 2 # 如連續十次輸入錯誤密碼啟動報警系統
注出廠設置此功能為關閉
(7)儲存設置並退出編程狀態
按 *
注每次設置完成後必須在1分鍾內按 * 儲存設置
4使用方法
1用戶輸入使用密碼即可啟動電控門鎖開門
2如果輸入有誤連按兩次 * 即可取消
3如果因誤操作而引發報警需輸入正確的密碼來關閉報警
4如果忘記密碼了可使用主板上的跳線開關RESET來恢復出廠設置先關閉電源將跳線開關撥
到ON位置再接通電源將跳線開關撥回OFF位置即可恢復出廠設置
5擴展功能
1編程密碼可擴展為超級用戶使編程密碼可控制多個不同使用密碼的鍵盤只需輸入編程密碼後
按 # 也可開門
2 用密碼可擴展為被脅持密碼如使用者被脅持時只需在輸入
密碼時將最後一位數的數值加1即可例如使用密碼為1234則輸入1235 # 後能啟動電控鎖開門
但同時亦啟動報警信號輸出
附安裝接線圖
注1在安裝接線時請先關閉電源勿帶電操作
2正常情況下電鎖是從電源控制器接出
Ⅳ 軟體概要設計說明書怎麼寫
通用的軟體概要設計說明書國家有標准。例如概要設計說明書(GB8567-88)包括如下內容:
1引言
1.1編寫目的
1.2背景
1.3定義
1.4參考資料
2總體設計
2.1需求規定
2.2運行環境
2.3基本設計概念和處理流程
2.4結構
2.5功能器求與程序的關系
2.6人工處理過程
2.7尚未問決的問題
3介面設計
3.1用戶介面
3.2外部介面
3.3內部介面
4運行設計
4.1運行模塊組合
4.2運行控制
4.3運行時間
5系統數據結構設計
5.1邏輯結構設計要點
5.2物理結構設計要點
5.3數據結構與程序的關系
6系統出錯處理設計
6.1出錯信息
6.2補救措施
6.3系統維護設計
根據具體項目內容可以有所微調。
Ⅵ 軟體使用手冊怎麼寫
在網上復制給你的
引言
1.1編寫目的
【闡明編寫手冊的目的。指明讀者對象。】
1.2項目背景
【說明項目來源、委託單位、開發單位及主管部門】
1.3 定義
【列出手冊中使用的專門術語的定義和縮寫詞的原意】
1.4參考資料
【列出有關資料的作者、標題、編號、發表日期、出版單位或資料來源,可包括:a.項目的計劃任務書、合同或批文;b.項目開發計劃;C. 需求規格說明書;d.概要設計說明書;e。詳細設計說明書;f.測試計劃;g。手冊中引用的其他資料、採用的軟體工程標准或軟體工程規范。】
2. 軟體概述
2.1目標
2.2功能
2.3 性能
a.數據精確度【包括輸入、輸出及處理數據的精度】
b.時間特性【如響應時間、處理時間、數據傳輸時間等。】
c.靈活性【在操作方式、運行環境需做某些變更時軟體的適應能力。】
3. 運行環境
3.1硬體
【列出軟體系統運行時所需的硬體最小配置,如
a. 計算機型號、主存容量;
b. 外存儲器、媒體、記錄格式、設備型號及數量;
c. 輸入、輸出設備;
d. 數據傳輸設備及數據轉換設備的型號及數量。】
3.2支持軟體
【如:a. 操作系統名稱及版本號;
b. 語言編譯系統或匯編系統的名稱及版本號;
c. 資料庫管理系統的名稱及版本號;
d. 其他必要的支持軟體。】
4. 使用說明
4.1安裝和初始化
【給出程序的存儲形式、操作命令、反饋信息及其含意、表明安裝完成的測試實例以及安裝所需的軟體工具等。】
4.2輸入
【給出輸入數據或參數的要求。】
4.2.1數據背景
【說明數據來源、存儲媒體、出現頻度、限制和質量管理等。】
4.2.2數據格式
【如:a。長度;b.格式基準;C,標號;d.順序;e。分隔符;f.詞彙表;g. 省略和重復;h.控制。】
4.2.3輸入舉例
4.3輸出
【給出每項輸出數據的說明】
4.3.l數據背景
【說明輸出數據的去向使用頻度、存放媒體及質量管理等。】
4.3.2數據格式
【詳細闡明每一輸出數據的格式,如:首部、主體和尾部的具體形式。】
4.3.3舉例
Ⅶ 系統文檔說明書怎麼寫具體的,求大神
軟體的使用文檔分為兩種常見的寫法,一種是俗稱「點點點」的幫助手冊類使用文檔,告知用戶每一步需要點擊的按鈕,用系統的截圖及指示去展現;另一種是偏需求文檔的形式,告知用戶為什麼這樣操作,怎麼操作。下面具體分析兩種寫法風格的場景選擇及寫發分析。
幫助手冊類使用文檔
此類使用文檔多用於業務邏輯簡單的系統,大多數的邏輯在頁面上可以展示,用戶只需要知道系統的使用流程,在哪些模塊實現哪些操作即可。用系統截圖+箭頭/符號的視覺指引來引導點擊區域,附帶著一些注意事項類的文字,基本可說明使用情況。
Ⅷ 軟體文檔怎麼寫
1.0概述 這部分提供對整個設計文檔的概述。描述了所有數據,結構,介面和軟體構件級別的設計。
1.1 目標和對象 描述軟體對象的所有目標。
1.2 陳述范圍 軟體描述。主要輸入,過程功能,輸出的描述,不考慮詳細細節。
1.3 軟體內容 軟體被置於商業或者產品線中,討論相關的戰略問題。目的是讓讀者能夠對「宏圖」有所了解。
1.4 主要系統參數 任何商務軟體或者產品線都包含軟體規定、設計、實現和測試的說明和規范。
2.0 數據設計 描述所有數據結構包括內部變數,全局變數和臨時數據結構。
2.1 內部軟體數據結構 描述軟體內部的構件之間的數據傳輸的結構。
2.2 全局數據結構 描述主要部分的數據結構。
2.3 臨時數據結構 為臨時應用而生成的文件的描述。
2.4 資料庫描述 作為應用程序的一部分,描述資料庫結構。
3.0 結構化和構件級別設計 描述程序結構。
3.1 程序結構 詳細描述應用程序所選定的程序結構。
3.1.1 結構圖 圖形化描述結構。
3.1.2 選擇性 討論其它可供考慮的結構。選定3.1.1中結構類型的原因。
3.2 構件描述 詳細描述結構中的每個軟體構件。
3.2.1 構件過程敘述(PSPEC) 描述構件的過程。
3.2.2 構件介面描述 詳細描述構件的輸入和輸出。
3.2.3 構件執行細節 每個構件的詳細演算描述。
3.2.3.1 介面描述
3.2.3.2 演算模型(e.g., PDL)
3.2.3.3 規范/限制 ]
3.2.3.4 本地數據結構
3.2.3.5 在3.2.3.6設計中包含的執行結果
3.3 軟體介面描述 軟體對外界的介面描述
3.3.1機器對外介面 與其他機器或者設備的介面描述。
3.3.2系統對外介面 對其它系統、產品和網路的介面描述。
3.3.3與人的介面 概述軟體與任何人的界面。
4.0 用戶界面設計 描述軟體的用戶界面設計。
4.1 描述用戶界面 詳細描述用戶界面,包括屏幕顯示圖標、圖片或者類型。
4.1.1 屏幕圖片 從用戶角度描述界面。
4.1.2 對象和操作 所有屏幕對象和操作的定義。
4.2 界面設計規范 用戶界面的設計和實現的規范和標准。
4.3 可見構件 實現的GUI可見構件說明。
4.4 UIDS描述 用戶界面開發系統描述。
5.0約束、限制和系統參數 會影響軟體的規格說明、設計和實現的特殊事件。
6.0測試標准 測試策略和預備測試用例描述。
6.1 測試的類別 規定實施測試的類別,包括盡量詳細的描述。這里是針對黑盒測試現象的描述。
6.2期待軟體反饋 測試期待的結果描述。
6.3執行界線 特殊執行需要的說明。
6.4 重要構件確認 決定性構件或者需要特殊注意的構件的測試確認。
7.0附錄 設計說明的補充信息。
7.1系統可跟蹤矩陣 一個定期回歸系統規格跟蹤軟體需求的矩陣。
7.2 產品戰略 如果規格說明書是為一個產品設計的,描述相關的產品戰略。
7.3 使用分析演算法 描述所有分析活動所使用到的分析演算法。
7.4 補充信息 (如果有需要特別說明的)
Ⅸ 軟體需求說明怎麼寫
近來學校的一些科研項目又在申報了,一些學弟開始Q我一些軟體工程上書面的問題。大概的總結了下,寫到這里。本文涉及到的是需求分析部分的書寫,主要是根據國家標准文檔中的要求來的。
在互聯網公司或者一些敏捷開發的公司里,其實大家都是秉承著重開發,重討論,而輕文檔的態度。這個輕文檔並不是指沒有文檔或者幾乎不做文檔,而是在嚴格的文檔流程中解脫出來,只把最最實際的部分寫出來。這個特徵是有互聯網本身迭代周期短,版本發布快等特點決定的。而在實際的兼職項目的時候,同學們就要注意了,最重要的應該就是在簽合同的時候一定要附上最清楚的一份需求分析,雖然這份需求說明可能不是按照某些標准文檔而來的,描述清楚每個功能達到的效果,而這個效果一定要讓客戶點頭確認,而不能出現「應該是」、「可能是」、「也許是」這樣的模糊回答。否則在項目後期就會比較難過了。在學校申請的項目和大型公司項目開發中,是重視文檔流程的,一部一部來。所以還是看情況來對待文檔的深度和標准。
一、目錄:目錄要用word的「引用」—>」目錄」,自動生成目錄,一般都是要三級目錄。通常這部分基本都不需要改結構,直接更新頁碼即可。
二、內容部分。國家標准軟體需求說明書G856T-88下載
1引言
1.1編寫目的
說明編寫這份軟體需求說明書的目的,指出預期的讀者。
(這部分說明需求分析報告的概況,例如:本X需求分析報告是為S系統而編寫的。+S系統的兩句話概述。+本X報告旨在使U1(需求者)明確S系統的要求和細節,給U2(開發人員)了解需求實現的難度和困難,最終提供給U3(審核人、管理者)討論和審核,達到溝通效果)
1.2背景
說明:
a.待開發的軟體系統的名稱;
b.本項目的任務提出者、開發者、用戶及實現該軟體的計算中心或計算機網路;
c.該軟體系統同其他系統或其他機構的基本的相互來往關系。
(這部分可以將a,b,c分為2部分,例子如下:
1.2.1項目概況
本需求分析報告所預期開發的軟體系統是:S。S是(不是則無)SS系統的某一個功能子模塊,S和S1、S2等系統之間的聯系,以及概述其他系統的狀態等等。
1.2.2任務分配
a.任務提出者:xxx
b.軟體開發者:xx
c.產品使用者:xx
d.文檔編寫者:xx
e.預期產品使用者:xx
)
1.3定義
列出本文件中用到的專門術語的定義和外文首字母組詞的原片語。
(這部分很簡單,就是描述專業詞彙,比如
1. XML(Extensible Markup Language)即可擴展標記語言,它與HTML一樣,都是SGML(Standard Generalized Markup Language,標准通用標記語言)。
2. Word2,解釋。。。
)
1.4參考資料
列出用得著的參考資料,如:
a.本項目的經核準的計劃任務書或合同、上級機關的批文;
b.屬於本項目的其他已發表的文件;
c.本文件中各處引用的文件、資料、包括所要用到的軟體開發標准。列出這些文件資料的標題、文件編號、發表日期和出版單位,說明能夠得到這些文件資料的來源。
2任務概述
2.1目標
敘述該項軟體開發的意圖、應用目標、作用范圍以及其他應向讀者說明的有關該軟體開發的背景材料。解釋被開發軟體與其他有關軟體之間的關系。如果本軟體產品是一項獨立的軟體,而且全部內容自含,則說明這一點。如果所定義的產品是一個更大的系統的一個組成部分,則應說明本產品與該系統中其他各組成部分之間的關系,為此可使用一張方框圖來說明該系統的組成和本產品同其他各部分的聯系和介面。|
(
本模塊開發主要是為SS的整體服務,完成SS工作中的XX部分以及相關的工作。其涉及的范圍就是,從下達A、B命令後,到給出C結果的過程。具體描述:B1,來完成B11功能;B2,來完成B22功能;等等。本部分是(否)耦合在分詞工具包其他部分中的,主要為嵌入方式和先後方式相互交互。
圖
圖1.該系統的組成同其他各部分的聯系和介面
)
2.2用戶的特點
列出本軟體的最終用戶的特點,充分說明操作人員、維護人員的教育水平和技術專長,以及本軟體的預期使甩頻度。這些是軟體設計工作的重要約束
(例如:二次開發和系統調用人員:具有很高的專業知識水平,理解XX的運行機制。可以對開放代碼進行閱讀和分析,以完成其系統獨特的需求,提供給這部分用戶開放API手冊和Debug版本的源代碼即可;預期這部分用戶會占本系統總用戶量的多大部分。
xx使用者:具有一定的計算機操作能力和知識,了解xx領域的相關概念和用途。提供給這部分用戶操作手冊即可。預期這部分使用者主要是來簡單的xx操作。
維護人員:具有較高的計算機專業水平,可以對常見的系統Bug進行追蹤和分析,具有一定的測試能力。這部分用戶主要是採用了本系統之後的後期工作維護者。
等等
)
2.3假定和約束
列出進行本軟體開發工作的假定和約束,例如經費限制、開發期限等。
(這部分重要是對你有的技術力量、資金狀況、人力資源等情況的假設,以使得你可以在什麼樣的情況和時間范圍內完成工作。工期約束,經費約束,人員約束,地理約束,設備約束等幾個方面列舉說明。)
3需求規定
3.1對功能的規定
用列表的方式(例如IPO表即輸入、處理、輸出表的形式),逐項定量和定性地敘述對軟體所提出的功能要求,說明輸入什麼量、經怎樣的處理、得到什麼輸出,說明軟體應支持的終端數和應支持的並行操作的用戶數。
(例如:
INPUT輸入
PROCESS處理
OUTPUT輸出
LOAD負載量
A
預處理,做怎樣的動作,
AA
CC
B
BBBB
Bb
v
C
CCCC
cc
v
表一、xx模塊IPO表
對IPO表的簡單文字描述。
)
3.2對性能的規定
3.2.1精度
說明對該軟體的輸入、輸出數據精度的要求,可能包括傳輸過程中的精度。
(例如:
Xx目標處理:1Byt–10M,包括左右邊界值。
yy精度范圍:….
ZZ的精度:由於xx的特殊性,本系統均採用xx型來進行字元統計運算,概率部分以及其他比率部分精度精確到0.0x%。
)
3.2.2時間特性要求
說明對於該軟體的時間特性要求,如對:
a.響應時間;
b.更新處理時間;
c.數據的轉換和傳送時間;
d.解題時間;等的要求。
(這部分只要一一列舉就可以:
由於xxx過程中,需要大量xxxx操作或怎樣,故xx解題時間占總時間的最大部分。其次就是xx轉換和存儲的開銷。其具體時間特性要求,如下:
a.xx響應時間:xxms左右;
b.yy更新處理時間:yy;
c.zz數據的轉換和傳送時間:zz;
d.vv解題時間:vv。
等等
)
3.2.3靈活性
說明對該軟體的靈活性的要求,即當需求發生某些變化時,該軟體對這些變化的適應能力,如:
a.操作方式上的變化;
b.運行環境的變化;
c.同其他軟體的介面的變化;
d.精度和有效時限的變化;
e.計劃的變化或改進。
對於為了提供這些靈活性而進行的專門設計的部分應該加以標明。
(這部分按列舉來即可,由於本模塊第一目的是用於xxx,其次則是xxxx。故本模塊的靈活性在於實際應用者的不同。當需求發生某些變化時,該軟體對這些變化的適應能力。具體情況如下:
f.操作方式上的變化:採用集成運行制和獨立運行制兩種模式,集成運行制是把本模塊嵌入到分詞工具包的主框架中,提供給用戶具有一定UI的可操作軟體;獨立運行制是可以獨立運行於後台,並提供給各種程序調用的模式的工作方式,以增強其生命力。
g.運行環境的變化:主採用Windows平台的編譯版本運行和調試,在時間允許的情況下,同步開發支持SUSE Linux的伺服器版本。;
h.同其他軟體的介面的變化:在盡量保證介面不出現變動的情況下,允許介面的重載和再定義。但介面的命名規則是統一的;
i.精度和有效時限的變化:精度在必須調整的條件下,可以上下浮動10個百分點;有效時限則依據現實的測試情況允許稍大范圍的變化。
j.計劃的變化或改進:工作時間安排會存在必然的浮動,這部分要協同分詞工具包課題設計組其他成員一同來進行商定,前期的計劃可以稍微有些變動,後期的安排盡量按照計劃執行。
等等
)
3.3輸人輸出要求
解釋各輸入輸出數據類型,並逐項說明其媒體、格式、數值范圍、精度等。對軟體的數據輸出及必須標明的控制輸出量進行解釋並舉例,包括對硬拷貝報告(正常結果輸出、狀態輸出及異常輸出)以及圖形或顯示報告的描述。
(這部分可以把輸入輸出分為3.3.1輸入要求和3.3.2輸出要求,如下給出一個單元的例子。
XXX輸出
數據名稱:XXX輸出數據
實際含義:用於XX,表示XXXX
數據類型:Character(字元串)
數據格式:XX
數據約束:由於xxx,,大小在xx以內
)
3.4數據管理能力要求
說明需要管理的文卷和記錄的個數、表和文卷的大小規模,要按可預見的增長對數據及其分量的存儲要求作出估算。
(
根據實際系統要求列舉即可
Name名稱
Number數量
Size大小
Increase增長
詞典xx
xx
xxxx
並行執行,其大小依據實際xx大文本而增長
)
3.5故障處理要求
列出可能的軟體、硬體故障以及對各項性能而言所產生的後果和對故障處理的要求。
(包括軟體壓力,內存不足,硬體損壞等,這部分可以根據網路到其常見故障。)
3.6其他專門要求
如用戶單位對安全保密的要求,對使用方便的要求,對可維護性、可補充性、易讀性、可靠性、運行環境可轉換性的特殊要求等。
(例如安全保密性:密鑰更換等;預期擴展:擴展兼容等;OS更換:Slackware轉SUSE等
)
4運行環境規定
4.1設備
列出運行該軟體所需要的硬設備。說明其中的新型設備及其專門功能,包括:
a.處理器型號及內存容量;
b.外存容量、聯機或離線、媒體及其存儲格式,設備的型號及數量;
c.輸入及輸出設備的型號和數量,聯機或離線;
d.數據通信設備的型號和數量;
e.功能鍵及其他專用硬體
(列舉說明即可)
4.2支持軟體
列出支持軟體,包括要用到的操作系統、編譯(或匯編)程序、測試支持軟體等。
(操作系統和版本:xxxx
支撐環境和版本:xxxx
備用IDE環境和版本:xxxx
與該軟體有關的軟體組件:xxxx
後續可能擴展環境:xxxx
)
4.3介面
說明該軟體同其他軟體之間的介面、數據通信協議等。
(例如:
a.用戶和主程序調用介面(圖中介面1)。這個介面採用封裝API形式和函數調用形式,分別以外部調用和內部調用的方式為不同用戶提供使用本機械分詞工具的入口。例如以xxxx方式調用DLL文件,以xxxx方式調用函數。如下圖2所示。
圖2.軟體介面調用圖
b.xx介面(圖中介面2)。這里是一個xxx的介面調用過程。xxxx
)
4.4控制
說明控制該軟體的運行的方法和控制信號,並說明這些控制信號的來源。
(例如:
下面通過圖表的形式,將本模塊以及涉及到本模塊的軟體模塊的運行方法、控制信號,以及這些控制信號的來源,其中箭頭所指方向對應的模塊的控制信號來自箭頭另一方向的模塊,具體情況如下:
圖3 .控制流程圖
圖3的具體說明情況如下表所示:
Name模塊名稱
Method運行方式
Signal控制信號
Forward控制去向
主程序模塊
運行框架
用戶調用或運行
1.調用xx模塊
2.調用xx方法
3.調用標准輸出模塊
xxx模塊
xxx
xxx調用
Xxx模塊
)
附錄:軟體設計文檔國家標准(GB8567–88)軟體設計文檔國家標准(GB8567–88)GB8567——88
操作手冊(GB8567——88).doc 資料庫設計說明書(GB8567——88).doc
測試分析報告(GB8567——88).doc 數據要求說明書(GB856T——88).doc
測試計劃(GB8567——88).doc 圖1.doc
概要設計說明書(GB8567——88).doc 文件給制實施規定的實例(GB8567-88).doc
開發進度月報(GB8567——88).doc 詳細設計說明書(GB8567——88).doc
可行性研究報告(GB8567——88).doc 項目開發計劃(GB856T——88).doc
模塊開發卷宗(GB8567——88).doc 項目開發總結報告(GB8567——88).doc
軟體需求說明書(GB856T——88).doc 用戶手冊(GB8567——88).doc
Ⅹ 產品說明書怎麼寫
1、標題。通常是產品名稱後面加上說明書三個字,如《VCD說明書》。如果有些是側重介紹使用方法,稱為使用說明書,即產品名稱加上使用說明,如vcd使用說明。
2、正文。正文要詳細介紹產品的有關知識:產地、原料、功能、特點、原理、規格、使用方法、注意事項、維修保養等知識。當然,不同產品,其說明書側重的內容也不同。
一般的產品說明書分為⑴家用電器類。⑵日用生活品類。⑶食品葯物類。⑷大型機器設備類。⑸設計說明書。
3、附文。附文一般包括廠名、地址、電話、電掛、電傳、聯系人和生產日期等。出口產品在外包裝上要寫明生產日期、中外文對照。