7.軟件用戶手冊模板.doc

文件名稱：XXX軟件用戶手冊文件編號：XXX-B16-XXXXXX項(xiàng)目名稱：項(xiàng)目編號：物料編碼：版 本 號：文件密級：秘密文件狀態(tài)：CFC受控標(biāo)識：受控?cái)M制： 年 月 日審核： 年 月 日會簽：批準(zhǔn)： 年 月 日文件發(fā)放范圍：修訂頁序號版本號修訂內(nèi)容簡述擬制/日期審核批準(zhǔn)1A2B345678910111213141516引言版權(quán)聲明版權(quán)聲明，并說明相關(guān)的字樣徽標(biāo)。 編寫目的、版本、面向用戶說明：該用戶手冊所描述的軟件系統(tǒng)的名稱；該軟件手冊的版本、使用對象、編寫目的。特殊說明列出該手冊中用到的專門術(shù)語的定義和外文首字母組詞的原詞組以及特殊圖標(biāo)的說明。目 錄引言I版權(quán)聲明I編寫目的、版本、面向用戶I特殊說明I1產(chǎn)品概述11.1功能概述11.2運(yùn)行環(huán)境11.2.1硬件環(huán)境11.2.2軟件環(huán)境11.2.3數(shù)據(jù)結(jié)構(gòu)11.3軟件安裝12軟件使用介紹12.1概述12.2運(yùn)行界面12.2.1運(yùn)行情況12.2.2輸出格式12.2.3其他說明23 使用舉例24 常見問題處理25 相關(guān)文件21產(chǎn)品概述1.1 功能概述結(jié)合本軟件產(chǎn)品的開發(fā)目的逐項(xiàng)地說明本軟件所具有各項(xiàng)功能、適用范圍、特性、本軟件的適應(yīng)能力等。1.2 運(yùn)行環(huán)境1.2.1 硬件環(huán)境列出為運(yùn)行該軟件產(chǎn)品所要求的硬設(shè)備的最小配置，如：1. 處理機(jī)的型號、內(nèi)存容量；2. 所要求的外存儲器、媒體、記錄格式、設(shè)備的型號規(guī)格和臺數(shù)、聯(lián)機(jī)脫機(jī)；1.2.2 軟件環(huán)境說明為運(yùn)行本軟件所需要的支持軟件，如：1. 操作系統(tǒng)的名稱、版本號；2. 程序語言的編譯匯編系統(tǒng)的名稱和版本號；3. 數(shù)據(jù)庫管理系統(tǒng)的名稱和版本號；4. 其他支持軟件。1.2.3 數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫或數(shù)據(jù)文卷。1.3 軟件安裝安裝與初始化：逐步說明為使用本軟件而需進(jìn)行的安裝與初始化過程，包括程序的存儲形式、安裝與初始化過程中的全部操作命令、系統(tǒng)對這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測試實(shí)例等。如果有的話，還應(yīng)說明安裝過程中所需用到的專用軟件。2 軟件使用介紹2.1 概述整體上對該軟件的說明，羅列該軟件的運(yùn)行中需要注意的一些參數(shù)、設(shè)置。2.2 運(yùn)行界面介紹軟件的運(yùn)行界面的結(jié)構(gòu)、特色、操作等。2.2.1 運(yùn)行情況針對軟件運(yùn)行后的使用流程，主要是1. 具體使用方法2. 正常情況的處理3. 限制4. 特殊情況的處理2.2.2 輸出格式說明對軟件運(yùn)行的結(jié)果的格式要求，包括語法規(guī)則和有關(guān)約定，如：1. 長度一例如字符數(shù)行，字符數(shù)項(xiàng)；2. 格式基準(zhǔn)例如以左面的邊沿為基準(zhǔn)；3. 標(biāo)號例如標(biāo)記或標(biāo)識符；4. 順序例如各個數(shù)據(jù)項(xiàng)的次序及位置；5. 標(biāo)點(diǎn)例如用來表示行、數(shù)據(jù)組等的開始或結(jié)束而使用的空格、斜線、星號、字符組等。6. 詞匯表給出允許使用的字符組合的列表，禁止使用的字符組合的列表等；2.2.3 其他說明3 使用舉例4 常見問題處理列出由軟件產(chǎn)生時的修改糾正工作。指出為了確保再啟動和恢復(fù)的能力，用戶必須遵循的處理過程。5 相關(guān)文件軟件用戶手冊編寫規(guī)范