(完整版)用戶(hù)手冊(cè)Word模板

1、1 引言 21.1 編寫(xiě)目的 21.2 背景 21.3 定義 21.4 參考資料 22 用途 22.1 功能 22.2 性能 32.2.1 精度 32.2.2 時(shí)間特性 32.2.3 靈活性 32.3 安全保密 33 運(yùn)行環(huán)境 33.1 硬設(shè)備 33.2 支持軟件 33.3 數(shù)據(jù)結(jié)構(gòu) 44 使用過(guò)程 44.1 安裝與初始化 44.2 輸入 44.2.1 輸入數(shù)據(jù)的現(xiàn)實(shí)背景 44.2.2 輸入格式 44.2.3 輸入舉例 54.3 輸出對(duì)每項(xiàng)輸出作出說(shuō)明 54.3.1 輸出數(shù)據(jù)的現(xiàn)實(shí)背景 54.3.2 輸出格式 54.3.3 輸出舉例 54.4 文卷查詢(xún) 64.5 出錯(cuò)處理和恢復(fù) 64.6 終端

2、操作 6用戶(hù)手冊(cè)1 引言1.1 編寫(xiě)目的說(shuō)明編寫(xiě)這份用戶(hù)手冊(cè)的目的，指出預(yù)期的讀者。1.2 背景說(shuō)明：a. 這份用戶(hù)手冊(cè)所描述的軟件系統(tǒng)的名稱(chēng)；b. 該軟件項(xiàng)目的任務(wù)提出者、 開(kāi)發(fā)者、 用戶(hù) （或首批用戶(hù)） 及安裝此軟件的計(jì)算中心。1.3 定義列出本文件中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。1.4 參考資料列出有用的參考資料，如：a. 項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文；b. 屬于本項(xiàng)目的其他已發(fā)表文件；c. 本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件資料的來(lái)源。2 用途1.1 功能

3、結(jié)合本軟件的開(kāi)發(fā)目的逐項(xiàng)地說(shuō)明本軟件所具有各項(xiàng)功能以及它們的極限范圍。1.2 性能1.2.1 精度逐項(xiàng)說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度， 包括傳輸中的精度 要求。1.2.2 時(shí)間特性定量地說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)間等。1.2.3 靈活性說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶(hù)需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求）有某些變化時(shí)，本軟件的適應(yīng)能力。1.3 安全保密說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。3 運(yùn)行環(huán)境3.1 硬設(shè)備列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如：a. 處理機(jī)的型號(hào)、內(nèi)存容

4、量；b. 所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)脫機(jī)；c. IO 設(shè)備（聯(lián)機(jī)脫機(jī)？） ；d. 數(shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。3.2 支持軟件說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如：abcd操作系統(tǒng)的名稱(chēng)、版本號(hào)； 程序語(yǔ)言的編譯匯編系統(tǒng)的名稱(chēng)和版本號(hào)； 數(shù)據(jù)庫(kù)管理系統(tǒng)的名稱(chēng)和版本號(hào)； 其他支持軟件。3.3 數(shù)據(jù)結(jié)構(gòu)列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。4 使用過(guò)程在本章， 首先用圖表的形式說(shuō)明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、 輸出接收機(jī)構(gòu)之間的關(guān)系。4.1 安裝與初始化一步一步地說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程， 包括程序的存儲(chǔ)形式、 安裝與初始化過(guò)程中

5、的全部操作命令、 系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。 表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專(zhuān)用軟件。4.2 輸入規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。4.2.1 輸入數(shù)據(jù)的現(xiàn)實(shí)背景說(shuō)明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是a. 情況例如人員變動(dòng)、庫(kù)存缺貨； b. 情況出現(xiàn)的頻度例如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù)； c. 情況來(lái)源一例如人事部門(mén)、倉(cāng)庫(kù)管理部門(mén)； d. 輸入媒體例如鍵盤(pán)、穿孔卡片、磁帶； e. 限制出于安全、保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制； f. 質(zhì)量管理例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等； g. 支配例如如

6、何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。4.2.2 輸入格式說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則和有關(guān)約定，如：a. 長(zhǎng)度一例如字符數(shù)行，字符數(shù)項(xiàng)； b. 格式基準(zhǔn)例如以左面的邊沿為基準(zhǔn)； c. 標(biāo)號(hào)例如標(biāo)記或標(biāo)識(shí)符； d. 順序例如各個(gè)數(shù)據(jù)項(xiàng)的次序及位置； e. 標(biāo)點(diǎn)例如用來(lái)表示行、數(shù)據(jù)組等的開(kāi)始或結(jié)束而使用的空格、斜線、星號(hào)、字符組等。 f. 詞匯表給出允許使用的字符組合的列表，禁止使用的字符組合的列表等； g. 省略和重復(fù)給出用來(lái)表示輸人元素可省略或重復(fù)的表示方式； h. 控制給出用來(lái)表示輸入開(kāi)始或結(jié)束的控制信息。4.2.3 輸入舉例為每個(gè)完整的輸入形式提供

7、樣本，包括：a 控制或首部例如用來(lái)表示輸入的種類(lèi)和類(lèi)型的信息，標(biāo)識(shí)符輸入日期，正文起點(diǎn)和對(duì)所用編碼的規(guī)定；b 主體輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分； c 尾部用來(lái)表示輸入結(jié)束的控制信息，累計(jì)字符總數(shù)等； d 省略指出哪些輸入數(shù)據(jù)是可省略的； e 重復(fù)指出哪些輸入數(shù)據(jù)是重復(fù)的。4.3 輸出對(duì)每項(xiàng)輸出作出說(shuō)明4.3.1 輸出數(shù)據(jù)的現(xiàn)實(shí)背景說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：a 使用這些輸出數(shù)據(jù)是給誰(shuí)的，用來(lái)干什么；b 使用頻度例如每周的、定期的或備查閱的；c 媒體打印、 CRI 顯示、磁帶、卡片、磁盤(pán)，d 質(zhì)量管理一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定；e 支配例如如何確定輸出數(shù)據(jù)是保留還是廢

8、棄，是否要分配給其他接受者等。4.3.2 輸出格式給出對(duì)每一類(lèi)輸出信息的解釋?zhuān)饕牵篴 首部如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)；b 主體輸出信息的主體，包括分欄標(biāo)題；c 尾部包括累計(jì)總數(shù)，結(jié)束標(biāo)記。4.3.3 輸出舉例為每種輸出類(lèi)型提供例子。對(duì)例子中的每一項(xiàng)，說(shuō)明：a 定義每項(xiàng)輸出信息的意義和用途；b 來(lái)源是從特定的輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出、或從軟件的計(jì)算過(guò)程中得到；c 特性輸出的值域、計(jì)量單位、在什么情況下可缺省等。4.4 文卷查詢(xún)這一條的編寫(xiě)針對(duì)具有查詢(xún)能力的軟件， 內(nèi)容包括： 同數(shù)據(jù)庫(kù)查詢(xún)有關(guān)的初始化、 準(zhǔn)備、 及處理所需要的詳細(xì)規(guī)定，說(shuō)明查詢(xún)的能力、方式，所使用的命令和所要求的控制規(guī)定。4.5 出錯(cuò)處理和恢復(fù)列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶(hù)承擔(dān)的修改糾正工作。 指出