軟件開發(fā)用戶手冊_第1頁
軟件開發(fā)用戶手冊_第2頁
軟件開發(fā)用戶手冊_第3頁
軟件開發(fā)用戶手冊_第4頁
全文預(yù)覽已結(jié)束

下載本文檔

版權(quán)說明:本文檔由用戶提供并上傳,收益歸屬內(nèi)容提供方,若內(nèi)容存在侵權(quán),請進(jìn)行舉報或認(rèn)領(lǐng)

文檔簡介

軟件用戶手冊(SUM)說明:1.《軟件用戶手冊》(SUM)描述手工操作該軟件的用戶應(yīng)如何安裝和使用一個計算機(jī)軟件配置項(CSCI),一組CSCI,一個軟件系統(tǒng)或子系統(tǒng)。它還包括軟件操作的一些特別的方面,諸如,關(guān)于特定崗位或任務(wù)的指令等。2.SUM是為由用戶操作的軟件而開發(fā)的,具有要求聯(lián)機(jī)用戶輸入或解釋輸出顯示的用戶界面。如果該軟件是被嵌人在一個硬件一軟件系統(tǒng)中,由于已經(jīng)有了系統(tǒng)的用戶手冊或操作規(guī)程,所以可能不需要單獨的SUM.1引言1.1標(biāo)識本條應(yīng)包含本文檔適用的系統(tǒng)和軟件的完整標(biāo)識,(若適用)包括標(biāo)識號、標(biāo)題、縮略詞語、版本號和發(fā)行號。1.2系統(tǒng)概述本條應(yīng)簡述本文檔適用的系統(tǒng)和軟件的用途。它應(yīng)描述系統(tǒng)和軟件的一般特性;概述系統(tǒng)的開發(fā)、運行與維護(hù)歷史;標(biāo)識項目的投資方、需方、用戶、開發(fā)方和支持機(jī)構(gòu);標(biāo)識當(dāng)前和計劃的運行現(xiàn)場;并列出其他有關(guān)的文檔。1.3文檔概述本條應(yīng)概述本文檔的用途和內(nèi)容,并描述與其使用有關(guān)的保密性或私密性要求。2引用文件本章應(yīng)列出本文檔引用的所有文檔的編號、標(biāo)題、修訂版本和日期。也應(yīng)標(biāo)識不能通過正常的供貨渠道獲得的所有文檔的來源。3軟件綜述本章應(yīng)分為以下幾條。3.1軟件應(yīng)用本條應(yīng)簡要說明軟件預(yù)期的用途。應(yīng)描述其能力、操作上的改進(jìn)以及通過本軟件的使用而得到的利益。3.2軟件清單本條應(yīng)標(biāo)識為了使軟件運行而必須安裝的所有軟件文件,包括數(shù)據(jù)庫和數(shù)據(jù)文件。標(biāo)識應(yīng)包含每份文件的保密性和私密性要求和在緊急時刻為繼續(xù)或恢復(fù)運行所必需的軟件的標(biāo)識。3.3軟件環(huán)境本條應(yīng)標(biāo)識用戶安裝并運行該軟件所需的硬件、軟件、手工操作和其他的資源。(若適用)包括以下標(biāo)識:必須提供的計算機(jī)設(shè)備,包括需要的內(nèi)存數(shù)量、需要的輔存數(shù)量及外圍設(shè)備(諸如打印機(jī)和其他的輸入/輸出設(shè)備);必須提供的通信設(shè)備;必須提供的其他軟件,例如操作系統(tǒng)、數(shù)據(jù)庫、數(shù)據(jù)文件、實用程序和其他的支持系統(tǒng);必須提供的格式、過程或其他的手工操作;必須提供的其他設(shè)施、設(shè)備或資源。3.4軟件組織和操作概述本條應(yīng)從用戶的角度出發(fā),簡要描述軟件的組織與操作。(若適用)描述應(yīng)包括:從用戶的角度來看的軟件邏輯部件和每個部件的用途/操作的概述;用戶期望的性能特性,例如:1) 可接受的輸入的類型、數(shù)量、速率;2) 軟件產(chǎn)生的輸出的類型、數(shù)量、精度和速率;3) 典型的響應(yīng)時間和影響它的因素;4) 典型的處理時間和影響它的因素;5) 限制,例如可追蹤的事件數(shù)目;6) 預(yù)期的錯誤率;7) 預(yù)期的可靠性。該軟件執(zhí)行的功能與所接口的系統(tǒng)、組織或崗位之間的關(guān)系;為管理軟件而采取的監(jiān)督措施(例如口令)。3.5意外事故以及運行的備用狀態(tài)和方式(若適用)本條應(yīng)解釋在緊急時刻以及在不同運行狀態(tài)和方式下用戶處理軟件的差異。3.6保密性和私密性本條應(yīng)包含與該軟件有關(guān)的保密性和私密性要求的概述。(若適用)應(yīng)包括對非法制作軟件或文檔拷貝的警告。3.7幫助和問題報告本條應(yīng)標(biāo)識聯(lián)系點和應(yīng)遵循的手續(xù),以便在使用軟件時遇到的問題時獲得幫助并報告間題。4訪問軟件本章應(yīng)包含面向首次/臨時的用戶的逐步過程。應(yīng)向用戶提供足夠的細(xì)節(jié),以使用戶在學(xué)習(xí)軟件的功能細(xì)節(jié)前能可靠地訪問軟件。在合適的地方應(yīng)包含用“警告”或“注意”標(biāo)記的安全提示。4.1軟件的首次用戶本條應(yīng)分為以下幾條。4.1.1熟悉設(shè)備合適的話,本條應(yīng)描述以下內(nèi)容:打開與調(diào)節(jié)電源的過程;可視化顯示屏幕的大小與能力;光標(biāo)形狀,如果出現(xiàn)了多個光標(biāo)如何標(biāo)識活動的光標(biāo),如何定位光標(biāo)和如何使用光標(biāo);鍵盤布局和不同類型鍵與點擊設(shè)備的功能;關(guān)電過程,如果需要特殊的操作順序的話。4.1.2訪問控制本條應(yīng)提供用戶可見的軟件訪問與保密性特點的概述。(若適用)本條應(yīng)包括以下內(nèi)容:怎樣獲得和從誰那里獲得口令;如何在用戶的控制下添加、刪除或變更口令;與用戶生成的輸出報告及其他媒體的存儲和標(biāo)記有關(guān)的保密性和私密性要求。4.1.3安裝和設(shè)置本條應(yīng)描述為標(biāo)識或授權(quán)用戶在設(shè)備上訪問或安裝軟件、執(zhí)行安裝、配置軟件、刪除或覆蓋以前的文件或數(shù)據(jù)和鍵人軟件操作的參數(shù)必須執(zhí)行的過程。4.2啟動過程本條應(yīng)提供開始工作的步驟,包括任何可用的選項。萬一遇到困難時,應(yīng)包含一張問題定義的檢查單。4.3停止和掛起工作本條應(yīng)描述用戶如何停止或中斷軟件的使用和如何判斷是否是正常結(jié)束或終止。5使用軟件指南本章應(yīng)向用戶提供使用軟件的過程。如果過程太長或太復(fù)雜,按本章相同的段結(jié)構(gòu)添加第6章,第7章……,標(biāo)題含義與所選擇的章有關(guān)。文檔的組織依賴于被描述的軟件的特性。例如,一種辦法是根據(jù)用戶工作的組織、他們被分配的崗位、他們的工作現(xiàn)場和他們必須完成的任務(wù)來劃分章。對其他的軟件而言,讓第5章成為菜單的指南,讓第6章成為使用的命令語言的指南,讓第7章成為功能的指南更為合適。在5.3的子條中給出詳細(xì)的過程。依賴于軟件的設(shè)計,可能根據(jù)逐個功能,逐個菜單,逐個事務(wù)或其他的基礎(chǔ)方式來組織條。在合適的地方應(yīng)包含用“警告”或“注意”標(biāo)記的安全提示。5.1能力為了提供軟件的使用概況,本條應(yīng)簡述事務(wù)、菜單、功能或其他的處理相互之間的關(guān)系。5.2約定本條應(yīng)描述軟件使用的任何約定,例如使用的顏色、使用的警告鈴聲、使用的縮略詞語表和使用的命名或編碼規(guī)則。5.3處理過程本條應(yīng)解釋后續(xù)條(功能、菜單、屏幕)的組織,應(yīng)描述完成過程必需的次序。5.3.x(軟件使用的方面)本條的標(biāo)題應(yīng)標(biāo)識被描述的功能、菜單、事務(wù)或其他過程。(若適用)本條應(yīng)描述并給出以下各項的選擇與實例,包括:菜單、圖標(biāo)、數(shù)據(jù)錄人表、用戶輸入、可能影響軟件與用戶的接口的來自其他軟硬件的輸入、輸出、診斷或錯誤消息、或報警和能提供聯(lián)機(jī)描述或指導(dǎo)信息的幫助設(shè)施。給出的信息格式應(yīng)適合于軟件特定的特性.但應(yīng)使用一種二致的描述風(fēng)格,例如對菜單的描述應(yīng)保持一致,對事務(wù)描述應(yīng)保持一致。5.4相關(guān)處理本條應(yīng)標(biāo)識并描述任何關(guān)于不被用戶直接調(diào)用,并且在5.3中也未描述的由軟件所執(zhí)行的批處理、脫機(jī)處理或后臺處理。應(yīng)說明支持這種處理的用戶職責(zé)。5.5數(shù)據(jù)備份本條應(yīng)描述創(chuàng)建和保留備份數(shù)據(jù)的過程,這些備份數(shù)據(jù)在發(fā)生錯誤、缺陷、故障或事故時可以用來代替主要的數(shù)據(jù)拷貝。5.6錯誤,故障和緊急情況時的恢復(fù)本條應(yīng)給出從處理過程中發(fā)生的錯誤、故障中重啟或恢復(fù)的詳細(xì)步驟和保證緊急時刻運行的連續(xù)性的詳細(xì)步驟。5.7消息本條應(yīng)列出完成用戶功能時可能發(fā)生的所有錯誤消息、診斷消息和通知性消息,或引用列出這些消息的附錄。應(yīng)標(biāo)識和描述每一條消息的含義和消息出現(xiàn)后要采取的動作。5.8快速引用指南如果適用于該軟件的話,本條應(yīng)為使用該軟件提供或引用快速引用卡或頁。如果合適,快速引用指南應(yīng)概述常用的功能鍵、控制序列、格式、命令或軟件使用的其他方面。6注解本章應(yīng)包含有助于理解本文檔的一般信息(例如背景信息、詞匯表、原理)。本

溫馨提示

  • 1. 本站所有資源如無特殊說明,都需要本地電腦安裝OFFICE2007和PDF閱讀器。圖紙軟件為CAD,CAXA,PROE,UG,SolidWorks等.壓縮文件請下載最新的WinRAR軟件解壓。
  • 2. 本站的文檔不包含任何第三方提供的附件圖紙等,如果需要附件,請聯(lián)系上傳者。文件的所有權(quán)益歸上傳用戶所有。
  • 3. 本站RAR壓縮包中若帶圖紙,網(wǎng)頁內(nèi)容里面會有圖紙預(yù)覽,若沒有圖紙預(yù)覽就沒有圖紙。
  • 4. 未經(jīng)權(quán)益所有人同意不得將文件中的內(nèi)容挪作商業(yè)或盈利用途。
  • 5. 人人文庫網(wǎng)僅提供信息存儲空間,僅對用戶上傳內(nèi)容的表現(xiàn)方式做保護(hù)處理,對用戶上傳分享的文檔內(nèi)容本身不做任何修改或編輯,并不能對任何下載內(nèi)容負(fù)責(zé)。
  • 6. 下載文件中如有侵權(quán)或不適當(dāng)內(nèi)容,請與我們聯(lián)系,我們立即糾正。
  • 7. 本站不保證下載資源的準(zhǔn)確性、安全性和完整性, 同時也不承擔(dān)用戶因使用這些下載資源對自己和他人造成任何形式的傷害或損失。

評論

0/150

提交評論