?? gb8567-88-10.htm
字號(hào):
<HTML><HEAD><META NAME="GENERATOR" Content="Microsoft Visual Studio 6.0"><TITLE></TITLE></HEAD><BODY><P><b>計(jì)算機(jī)軟件產(chǎn)品開(kāi)發(fā)文件編制指南 GB 8567-88</b></P><P><strong>14 用戶(hù)手冊(cè) <br> </strong> 用戶(hù)手冊(cè)的編制是要使用非專(zhuān)門(mén)術(shù)語(yǔ)的語(yǔ)言，充分地描述該軟件系統(tǒng)所具有的功能及基本的使用方法。使用戶(hù)（或潛在用戶(hù)）通過(guò)本手冊(cè)能夠了解該軟件的用途，并且能夠確定在什么情況下，如何使用它。具體的內(nèi)容要求如下：<br> <strong>14.1引言 <br> </strong> 14.1．1編寫(xiě)目的 <br> 14.1.2背景 <br> 14.1．3定義 <br> 14.1.4參考資料<br> <strong>14.2用途</strong><br> 14.2．1功能<br> 14. 2． 2性能<br> 14. 2． 2． 1精度 <br> 14.2.2．2時(shí)間特性<br> 14. 2． 2． 3靈活性 <br> 14. 2. 3安全保密<br> <strong>14. 3運(yùn)行環(huán)境 </strong><br> 14.3.1硬設(shè)備 <br> 14. 3. 2支持軟件 <br> 14. 3. 3數(shù)據(jù)結(jié)構(gòu) <br> <strong>14. 4使用過(guò)程 </strong><br> 14.4.1安裝與初始化<br> 14． 4． 2輸入<br> 14.4.2.1輸入數(shù)據(jù)的現(xiàn)實(shí)背景<br> 14. 4. 2． 2輸入格式<br> 14. 4． 2． 3輸入舉例 <br> 14．4．3輸出 <br> 14.4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景 <br> 14. 4. 3.2輸出格式<br> 14.4.3.3輸出舉例 <br> 14.4.4文卷查詢(xún) <br> 14.4.5出錯(cuò)處理與恢復(fù) <br> 14.4.6終端操作 </P><P><strong>附錄H <br> 用戶(hù)手冊(cè)的編寫(xiě)提示 <br> （參考件）<br> </strong><strong>H.1引言 </strong><br> <br> <strong>H.1.1編寫(xiě)目的<br> </strong> 說(shuō)明編寫(xiě)這份用戶(hù)手冊(cè)的目的，指出預(yù)期的讀者。 <br> <strong>H.1.2背景</strong><br> 說(shuō)明：<br> a.這份用戶(hù)手冊(cè)所描述的軟件系統(tǒng)的名稱(chēng)；<br> b．該軟件項(xiàng)目的任務(wù)提出者、開(kāi)發(fā)者、用戶(hù)（或首批用戶(hù)）及安裝此軟件的計(jì)算中心。<br> <strong> H.1.3定義</strong><br> 列出本文件中用到的專(zhuān)門(mén)術(shù)語(yǔ)的定義和外文首字母組詞的原詞組。<br> <strong> H.1.4參考資料 </strong><br> 列出有用的參考資料，如：<br> a.項(xiàng)目的經(jīng)核準(zhǔn)的計(jì)劃任務(wù)書(shū)或合同、上級(jí)機(jī)關(guān)的批文；<br> b．屬于本項(xiàng)目的其他已發(fā)表文件； <br> c．本文件中各處引用的文件、資料，包括所要用到的軟件開(kāi)發(fā)標(biāo)準(zhǔn)。 列出這些文件資料的標(biāo)題、文件編號(hào)、發(fā)表日期和出版單位，說(shuō)明能夠取得這些文件資料的來(lái)源。<br> <strong>H．2用途<br> </strong><br> <strong>H.2．1功能<br> </strong> 結(jié)合本軟件的開(kāi)發(fā)目的逐項(xiàng)地說(shuō)明本軟件所具有各項(xiàng)功能以及它們的極限范圍。<br> <strong>H.2.2性能<br> </strong> H.2.2.1精度 <br> 逐項(xiàng)說(shuō)明對(duì)各項(xiàng)輸入數(shù)據(jù)的精度要求和本軟件輸出數(shù)據(jù)達(dá)到的精度，包括傳輸中的精度要求。<br> H.2.2.2時(shí)間特性 <br> 定量地說(shuō)明本軟件的時(shí)間特性，如響應(yīng)時(shí)間，更新處理時(shí)間，數(shù)據(jù)傳輸、轉(zhuǎn)換時(shí)間，計(jì)算時(shí)間等。 <br> H.2.2.3靈活性 <br> 說(shuō)明本軟件所具有的靈活性，即當(dāng)用戶(hù)需求（如對(duì)操作方式、運(yùn)行環(huán)境、結(jié)果精度、時(shí)間特性等的要求）有某些變化時(shí)，本軟件的適應(yīng)能力。<br> <strong> H． 2． 3 安 全保密</strong><br> 說(shuō)明本軟件在安全、保密方面的設(shè)計(jì)考慮和實(shí)際達(dá)到的能力。<br> <strong>H.3運(yùn)行環(huán)境</strong><br> <br> <strong>H.3.1 硬設(shè)備<br> </strong> 列出為運(yùn)行本軟件所要求的硬設(shè)備的最小配置，如： <br> a.處理機(jī)的型號(hào)、內(nèi)存容量; <br> b．所要求的外存儲(chǔ)器、媒體、記錄格式、設(shè)備的型號(hào)和臺(tái)數(shù)、聯(lián)機(jī)／脫機(jī)；<br> c. I／O設(shè)備（聯(lián)機(jī)／脫機(jī)？）； <br> d．?dāng)?shù)據(jù)傳輸設(shè)備和轉(zhuǎn)換設(shè)備的型號(hào)、臺(tái)數(shù)。<br> <strong>H．3．2支持軟件</strong><br> 說(shuō)明為運(yùn)行本軟件所需要的支持軟件，如：<br> a．操作系統(tǒng)的名稱(chēng)、版本號(hào)；<br> b．程序語(yǔ)言的編譯／匯編系統(tǒng)的名稱(chēng)和版本號(hào)；<br> c．?dāng)?shù)據(jù)庫(kù)管理系統(tǒng)的名稱(chēng)和版本號(hào)；<br> d．其他支持軟件。<br> <strong>H．3.3數(shù)據(jù)結(jié)構(gòu) <br> </strong> 列出為支持本軟件的運(yùn)行所需要的數(shù)據(jù)庫(kù)或數(shù)據(jù)文卷。<br> <strong>H．4使用過(guò)程 <br> </strong> 在本章，首先用圖表的形式說(shuō)明軟件的功能同系統(tǒng)的輸入源機(jī)構(gòu)、輸出接收機(jī)構(gòu)之間的關(guān)系。<br> <strong>11． 4． 1安裝與初始化 </strong><br> 一步一步地說(shuō)明為使用本軟件而需進(jìn)行的安裝與初始化過(guò)程，包括程序的存儲(chǔ)形式、安裝與初始化過(guò)程中的全部操作命令、系統(tǒng)對(duì)這些命令的反應(yīng)與答復(fù)。表征安裝工作完成的測(cè)試實(shí)例等。如果有的話，還應(yīng)說(shuō)明安裝過(guò)程中所需用到的專(zhuān)用軟件。<br> <strong>H.4．2輸入<br> </strong> 規(guī)定輸入數(shù)據(jù)和參量的準(zhǔn)備要求。<br> H．4．2．1輸入數(shù)據(jù)的現(xiàn)實(shí)背景<br> 說(shuō)明輸入數(shù)據(jù)的現(xiàn)實(shí)背景，主要是<br> a.情況--例如人員變動(dòng)、庫(kù)存‘缺貨；<br> b．情況出現(xiàn)的頻度--例如是周期性的、隨機(jī)的、一項(xiàng)操作狀態(tài)的函數(shù)．<br> c．情況來(lái)源--例如人事部門(mén)、倉(cāng)庫(kù)管理部門(mén)；<br> d．輸入媒體--例如鍵盤(pán)、穿孔卡片、磁帶；<br> e．限制--出于安全、保密考慮而對(duì)訪問(wèn)這些輸入數(shù)據(jù)所加的限制；<br> f．質(zhì)量管理--例如對(duì)輸入數(shù)據(jù)合理性的檢驗(yàn)以及當(dāng)輸入數(shù)據(jù)有錯(cuò)誤時(shí)應(yīng)采取的措施，如建立出錯(cuò)情況的記錄等；<br> g．支配--例如如何確定輸入數(shù)據(jù)是保留還是廢棄，是否要分配給其他的接受者等。<br> H．4．2．2輸入格式 <br> 說(shuō)明對(duì)初始輸入數(shù)據(jù)和參量的格式要求，包括語(yǔ)法規(guī)則和有關(guān)約定，如：<br> a．長(zhǎng)度—一例如字符數(shù)／行，字符數(shù)／項(xiàng)；<br> b．格式基準(zhǔn)--例如以左面的邊沿為基準(zhǔn)；<br> c．標(biāo)號(hào)--例如標(biāo)記或標(biāo)識(shí)符； <br> d．順序--例如各個(gè)數(shù)據(jù)項(xiàng)的次序及位置；<br> e.標(biāo)點(diǎn)--例如用來(lái)表示行、數(shù)據(jù)組等的開(kāi)始或結(jié)束而使用的空格、斜線、星號(hào)、字符組等。<br> f．詞匯表--給出允許使用的字符組合的列表，禁止使用＊的字符組合的列表等；<br> g．省略和重復(fù)--給出用來(lái)表示輸人元素可省略或重復(fù)的表示方式；<br> h．控制--給出用來(lái)表示輸入開(kāi)始或結(jié)束的控制信息。 <br> H.4.2．3輸入舉例 <br> 為每個(gè)完整的輸入形式提供樣本，包括： <br> a．控制或首部--例如用來(lái)表示輸入的種類(lèi)和類(lèi)型的信息，標(biāo)識(shí)符輸入日期，正文起點(diǎn)和對(duì)所用編碼的規(guī)定； <br> b．主體--輸入數(shù)據(jù)的主體，包括數(shù)據(jù)文卷的輸入表述部分；<br> c．尾部--用來(lái)表示輸入結(jié)束的控制信息，累計(jì)字符總數(shù)等； <br> d．省略--指出哪些輸入數(shù)據(jù)是可省略的；<br> e．重復(fù)--指出哪些輸入數(shù)據(jù)是重復(fù)的。<br> <strong>H．4．3輸出 對(duì)每項(xiàng)輸出作出說(shuō)明. </strong><br> H.4.3.1輸出數(shù)據(jù)的現(xiàn)實(shí)背景，<br> 說(shuō)明輸出數(shù)據(jù)的現(xiàn)實(shí)背景，主要是：<br> a．使用--這些輸出數(shù)據(jù)是給誰(shuí)的，用來(lái)干什么； <br> b.使用頻度--例如每周的、定期的或備查閱的；<br> c．媒體--打印、CRI顯示、磁帶、卡片、磁盤(pán)， <br> d．質(zhì)量管理—一例如關(guān)于合理性檢驗(yàn)、出錯(cuò)糾正的規(guī)定；<br> e．支配--例如如何確定輸出數(shù)據(jù)是保留還是廢棄，是否要分配給其他接受者等。<br> H.4.2.2輸出格式 <br> 給出對(duì)每一類(lèi)輸出信息的解釋?zhuān)饕牵?lt;br> a．首部--如輸出數(shù)據(jù)的標(biāo)識(shí)符，輸出日期和輸出編號(hào)；<br> b．主體--輸出信息的主體，包括分欄標(biāo)題；<br> c．尾部--包括累計(jì)總數(shù)，結(jié)束標(biāo)記。<br> H.4.33輸出舉例 <br> 為每種輸出類(lèi)型提供例子。對(duì)例子中的每一項(xiàng)，說(shuō)明：<br> a．定義--每項(xiàng)輸出信息的意義和用途； <br> b．來(lái)源--是從特定的輸入中抽出、從數(shù)據(jù)庫(kù)文卷中取出、或從軟件的計(jì)算過(guò)程中得到；<br> c．特性--輸出的值域、計(jì)量單位、在什么情況下可缺省等。<br> <strong>H.4.4文卷查詢(xún) </strong><br> 這一條的編寫(xiě)針對(duì)具有查詢(xún)能力的軟件，內(nèi)容包括：同數(shù)據(jù)庫(kù)查詢(xún)有關(guān)的初始化、準(zhǔn)備、及處理所需 要的詳細(xì)規(guī)定，說(shuō)明查詢(xún)的能力、方式，所使用的命令和所要求的控制規(guī)定。 <br> <strong>H.4.5出錯(cuò)處理和恢復(fù) <br> </strong> 列出由軟件產(chǎn)生的出錯(cuò)編碼或條件以及應(yīng)由用戶(hù)承擔(dān)的修改糾正工作。指出為了確保再啟動(dòng)和恢 復(fù)的能力，用戶(hù)必須遵循的處理過(guò)程。<br> <strong>H.4.6終端操作 </strong><br> 當(dāng)軟件是在多終端系統(tǒng)上工作時(shí)，應(yīng)編寫(xiě)本條，以說(shuō)明終端的配置安排、連接步釋、數(shù)據(jù)和參數(shù)輸入 步驟以及控制規(guī)定．說(shuō)明通過(guò)終端操作進(jìn)行查詢(xún)、檢索、修改數(shù)據(jù)文卷的能力、語(yǔ)言、過(guò)程以及輔助性程 序等。 <br> <strong></strong></P><P> </P></BODY></HTML>?? 快捷鍵說(shuō)明
復(fù)制代碼
Ctrl + C
搜索代碼
Ctrl + F
全屏模式
F11
切換主題
Ctrl + Shift + D
顯示快捷鍵
?
增大字號(hào)
Ctrl + =
減小字號(hào)
Ctrl + -