軟件產(chǎn)品使用說(shuō)明書格式

1、NIB匚NBC可視化協(xié)同辦公系統(tǒng)使用說(shuō)明書文件狀態(tài)：【】草稿【正式發(fā)布正在修改項(xiàng)目名稱Project文檔名稱使用說(shuō)明書文件標(biāo)識(shí)YGWY-Project-PM-UM當(dāng)前版本V0.1作者歐順寅完成時(shí)間YYYY-MM-DD頁(yè)數(shù)密級(jí)中北京陽(yáng)光偉業(yè)科技發(fā)展有限公司2010年5月文檔控制修改記錄起止日期修改類型*作者參與后版本備注YYYY-MM-DDYYYY-MM-DDAV0.1*修改類型分為AAddedMModifiedDDeleted審閱人姓名職位審閱簽字存檔存檔號(hào)地點(diǎn)/位置備注目錄1 概述41.1 背景41.2 應(yīng)用領(lǐng)域與使用對(duì)象41.1 參考資料41.2 術(shù)語(yǔ)與縮寫解釋42 系統(tǒng)綜述4系統(tǒng)結(jié)構(gòu)4系

2、統(tǒng)功能簡(jiǎn)介5性能5版權(quán)聲明5運(yùn)行環(huán)境5硬件設(shè)備要求5支持軟件5數(shù)據(jù)結(jié)構(gòu)5系統(tǒng)操作說(shuō)明6安裝與初始化6子模塊名稱16業(yè)務(wù)需求描述6界面截屏以及界面字段解釋6操作說(shuō)明6子模塊名稱26業(yè)務(wù)需求描述6界面截屏以及界面字段解釋6操作說(shuō)明7出錯(cuò)處理和恢復(fù)71概述背景系統(tǒng)的開發(fā)背景和編寫這個(gè)手冊(cè)的目的。應(yīng)用領(lǐng)域與使用對(duì)象描述軟件所能使用的領(lǐng)域以及使用對(duì)象等。參考資料列出有關(guān)資料的作者、標(biāo)題、編號(hào)、發(fā)表日期、出版單位或資料來(lái)源，可包括與該產(chǎn)品有關(guān)的已發(fā)表的資料文檔中所引用的資料，所采用的軟件標(biāo)準(zhǔn)或規(guī)范或業(yè)務(wù)規(guī)則編P資料名稱簡(jiǎn)介作者日期出版單位列出編寫本說(shuō)明書時(shí)查閱的Internet上雜志、專業(yè)著作、技術(shù)標(biāo)準(zhǔn)以

3、及他們的網(wǎng)址網(wǎng)址簡(jiǎn)介一術(shù)語(yǔ)與縮寫解釋列出本文中用到的專門術(shù)語(yǔ)的定義縮寫、術(shù)語(yǔ)解釋2系統(tǒng)綜述系統(tǒng)結(jié)構(gòu)結(jié)合系統(tǒng)所具有的功能包括輸入、處理和輸出提供該軟件的總體結(jié)構(gòu)圖表。系統(tǒng)功能簡(jiǎn)介結(jié)合本軟件的開發(fā)實(shí)際逐項(xiàng)地說(shuō)明本軟件所有具有各項(xiàng)功能。性能給出一般情況下的運(yùn)行性能指數(shù)等。版權(quán)聲明聲明版權(quán)所有者以及盜版應(yīng)承當(dāng)?shù)姆韶?zé)任。環(huán)境3.1硬件設(shè)備要求列出本軟件所要求的硬設(shè)備的最小配置，如：1、處理器的型號(hào)、內(nèi)存、硬盤容量；2、所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)/脫機(jī);3、I/O設(shè)備（聯(lián)機(jī)/脫機(jī)）；4、數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3.2支持軟件說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如：

4、1、操作系統(tǒng)的名稱、版本號(hào)；2、程序語(yǔ)言的編譯/匯編系統(tǒng)的名稱和版本號(hào)；3、數(shù)據(jù)庫(kù)系統(tǒng)的名稱和版本號(hào)；4、其他支持軟件。3.3數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)問(wèn)卷。4系統(tǒng)操作說(shuō)明首先用圖表的形式說(shuō)明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。安裝與初始化說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，包括程序的存儲(chǔ)形式、安裝與初始化過(guò)程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專用軟件。子模塊名稱1業(yè)務(wù)需求描述描述該模塊能實(shí)現(xiàn)什么業(yè)務(wù)功能界面截屏以及界面字段解釋對(duì)設(shè)計(jì)到該子模塊功能的所有UI界面進(jìn)

5、行截屏，并在各個(gè)截屏之后對(duì)頁(yè)面上的字段業(yè)務(wù)含義進(jìn)行解釋。操作說(shuō)明對(duì)該子模塊的用戶操作做一個(gè)詳細(xì)的說(shuō)明，盡量包含界面上的各個(gè)按鈕和鏈接，并對(duì)該操作以后會(huì)出現(xiàn)什么結(jié)果，達(dá)到什么功能詳加說(shuō)明。此處為用戶手冊(cè)的重點(diǎn)部分，如果有必要的話，此處可以分為很多更小的模塊來(lái)分別進(jìn)行操作說(shuō)明。子模塊名稱2業(yè)務(wù)需求描述描述該模塊能實(shí)現(xiàn)什么業(yè)務(wù)功能界面截屏以及界面字段解釋對(duì)設(shè)計(jì)到該子模塊功能的所有UI界面進(jìn)行截屏，并在各個(gè)截屏之后對(duì)頁(yè)面上的字段業(yè)務(wù)含義進(jìn)行解釋。操作說(shuō)明對(duì)該子模塊的用戶操作做一個(gè)詳細(xì)的說(shuō)明，盡量包含界面上的各個(gè)按鈕和鏈接，并對(duì)該操作以后會(huì)出現(xiàn)什么結(jié)果，達(dá)到什么功能詳加說(shuō)明。此處為用戶手冊(cè)的重點(diǎn)部分，如果有必要的話，此處可以分為很多更小