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