軟件操作手冊模板

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