用戶手冊的主要內(nèi)容及寫作要求-Read

用戶手冊的主要內(nèi)容及寫作要求編寫目的用戶手冊的編制是要使用非專門術(shù)語的語言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法。使用戶通過本手冊能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用。主要內(nèi)容及寫作要求用戶手冊的主要內(nèi)容及寫作要求如下：1引言1.1目的說明編寫本用戶手冊的目的。1.2背景列出本項目的任務(wù)提出者、項目負責(zé)人、系統(tǒng)分析員、系統(tǒng)設(shè)計員、程序設(shè)計員、程序員、資料員以及與本項目開展工作直接有關(guān)的人員和用戶。1.3參考資料列出編寫本用戶手冊時參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及它們的作者、標(biāo)題、編號、發(fā)布日期和出版單位等。1.4術(shù)語列出本用戶手冊中專門術(shù)語的定義以及英文編寫詞的原詞組。2用途2.1功能和性能逐項說明本軟件具有的各項功能及性能。對于大型模塊化軟件，應(yīng)分模塊描述其功能及性能。3運行環(huán)境3.1硬設(shè)備列出為運行本軟件所需要硬設(shè)備的最小配置，如：A.計算機型號，內(nèi)在容易；B.數(shù)據(jù)處理機的號型；C.所要求的外存儲器、設(shè)備型號和臺數(shù)（聯(lián)機/脫機）；D.輸入/輸出設(shè)備（聯(lián)機/脫機）；E.數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的號型、臺數(shù)。3.2支持軟件說明為運行本軟件所需要的支持軟件，如：A.操作系統(tǒng)的名稱和版本號；B.編程語言的編譯、匯編系統(tǒng)的名稱和版本號；C.數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號；D.其它支持軟件的名稱和版本號。4使用規(guī)程4.1安裝與初始化說明程序的存儲形式、安裝與初始化過程中的全部操作命令，系統(tǒng)對這些命令的反應(yīng)和

回答信息、表征安裝工作完成的測試實例以及安裝過程中使用的軟件工具。4.2輸入A.輸入設(shè)備及用途；B.操作方式和命令；C.輸入格式。4.3輸出A.輸出設(shè)備及用途（記帶、繪圖、打印、顯示等）；B.操作方式和命令；C.輸出格式。4.4文件查詢對具有查詢能力的軟件，說明查詢的能力、方式、所使用的命令和所要求的控制規(guī)定。4.5輸入?yún)?shù)，輸出信息及使用實例。4.5.1輸入?yún)?shù)的約定描述輸入的個數(shù)、位置、類型和缺省值。4.5.2輸出信息A.正常信息B.錯誤信息4.5.3使用實例的格式及內(nèi)容；的格式及內(nèi)容。給出使用實例。5出錯處理和恢復(fù)指出為了確保再啟動和恢復(fù)的能力，必須遵循的處理過程。6終端操作當(dāng)軟件是在多終端系統(tǒng)上工作時，應(yīng)編寫本條，以說明終端的配置安排、連接步驟、數(shù)和據(jù)參數(shù)輸入步驟以及控制規(guī)定。說明通過終端進行查詢、檢索、修改數(shù)文據(jù)件的能力、語言、過程以及輔助性程序等。操作手冊的主要內(nèi)容及寫作要求編寫目的操作手冊的編制為了向操作人員提供該軟件每一個運行的具體過程和有關(guān)知識，包括安裝和操作方法細節(jié)。如果一個軟件系統(tǒng)自控能力比較強，人機界面比較友好，安裝和操作比較簡單，本文檔可以不單獨編寫，并入用戶手冊。主要內(nèi)容及寫作要求操作手冊的主要內(nèi)容及寫作要求如下。1引言1.1編寫目的說明編寫這份操作手冊的目的，指出預(yù)期的讀者。1.2背景列出本項目的任務(wù)提出者、項目負責(zé)人、系統(tǒng)分析員、系統(tǒng)設(shè)計員、程序設(shè)計員、程序員、資料員以及與本項目開展工作直接有關(guān)的人員和用戶。

1.3參考資料列出編寫本用戶手冊時參考的文件、資料、技術(shù)標(biāo)準(zhǔn)以及它們的作者、標(biāo)題、編號、發(fā)布日期和出版單位等。1.4術(shù)語列出本操作手冊中專門術(shù)語的定義以及英文縮寫詞的原詞組。2軟件概述2.1軟件的結(jié)構(gòu)結(jié)合軟件系統(tǒng)所具有的功能包括輸入、處理和輸出提供該軟件的總體結(jié)構(gòu)圖表（常用系統(tǒng)流程圖表示）。2.2程序表列出本系統(tǒng)內(nèi)每個程序的標(biāo)識符、編號和助記名。2.3文卷表列出將由本系統(tǒng)引用、建立或更新的每個永久性文卷，說明它們各自的標(biāo)識符、編號、助記名、存儲媒體和存儲要求。3安裝與初始化一步一步地說明為使用本軟件而需要進行的安裝與初始化過程，包括程序的存載形式，安裝與初始化過程中的全部操作命令，系統(tǒng)對這些命令的反應(yīng)與答復(fù)，表征安裝工作完成的測試實例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。4運行說明所謂一個運行是指提供一個啟動控制信息后時為止的計算機系統(tǒng)執(zhí)行的全部過程。4.1運行列出每種可能的運行4.2運行步驟說明從一個運行轉(zhuǎn)向另一個運行4.3運行1（標(biāo)識符）說明1的有關(guān)信息，以對操作人員最方便最有用的形式加以說明。4.3.1運行控制，直到計算機系統(tǒng)等待另一個啟動控制信息表，摘要說明每個運行的目的，指出每個運行各自所執(zhí)行的程序。以完成整個系統(tǒng)運行的步驟。把運行列出為運行所需要的運行流向控制的說明。4.3.2操作信息給出為操作中心的操作人員和管理人員所需要的信息，如：A.運行目的；B.操作要求；C.啟動方法：如應(yīng)請啟動（由所遇到的請求信息啟動）、預(yù)定的時間啟動等；D.預(yù)計的運行時間和解題時間；E.操作命令；F.與運行有聯(lián)系的其他事項。4.3.3輸入――輸出文卷提供被本運行建立、更新或訪問的數(shù)據(jù)文卷的有關(guān)信息，如：A.文卷的標(biāo)識符或標(biāo)號；B.記錄媒體；C.存留的目錄表；D.文卷的支配：如確定保留和廢棄的準(zhǔn)則、是否要分配給其他接受者、占用硬設(shè)備的優(yōu)先級以及保密控制等有關(guān)規(guī)定。

4.3.4輸出文段提供本軟件輸出的每一個用于提示、說明或應(yīng)答的文段（包括“菜單”）的有關(guān)信息，如：A.文段的標(biāo)識符；B.輸出媒體（屏幕顯示、打印、……）；C.文字容量；D.分發(fā)對象；E.保密要求。4.3.5輸出文段的復(fù)制對由計算機產(chǎn)生，而后需用其它方法復(fù)制的那些文段提供有關(guān)信息，如：A.文段的標(biāo)識符；B.復(fù)制的技術(shù)手段；C.紙張或其他媒體的規(guī)格；D.裝訂要求；E.分發(fā)對象；F.復(fù)制份數(shù)。4.3.6恢復(fù)過程說明本運行故障后的恢復(fù)過程。4.4運行2（標(biāo)識符）說明用與本手冊4.3條相類似的方式介紹另一個運行的有關(guān)信息。5非