第五章 軟體使用手冊

軟體使用手冊(Software User Manual, SUM)主要目的乃在詳細描述軟體的使用方法，內容包括安裝、操作、疑難排除、維護與管理等細節，讓使用者能依照軟體使用手冊，順利操作及維護軟體系統。

(一)文件大綱

1、前言

(1)文件目的 (2)名詞解釋與縮寫符號(B、C) (3)參考文件資料(B、C) 2、軟體環境需求 3、組織架構摘述 4、安裝指南 (1)安裝步驟 (2)安裝之注意事項 5、操作描述 6、疑難排除 (1)線上錯誤訊息 (2)Help操作系統書面說明(B、C) (3)線上Help操作系統 (4)FAQ(C) 7、維護與管理 8、附錄

(二)分項說明

1、前言

(1)文件目的

摘要描述本文件之目的與內容。

(2)名詞解釋與縮寫符號(B、C)

描述在本文件中所使用到的特殊名詞、縮寫符號與簡稱。定義用字需解釋清楚、縮寫符號則需說明全文及其意義，並以英文字母順序表列。

(3)參考文件資料(B、C)

參考資料項目為一般國際標準文件所必需，記載並說明此軟體使用手冊中所參考引用之文獻及範例，軟體專案之文件，組織及作業手冊之編號、標題、改訂版、與日期，及其他相關的文件等。

2、軟體環境需求

描述使用者安裝軟體前，所必備的軟體環境、硬體環境、網路環境，例如，採用那一種作業系統？需要那些外掛軟體支援？所需硬體規格及網路設備規格等。

3、組織架構摘述

摘述軟體組織架構，讓使用者能初步瞭解該軟體的組成。此處可參考軟體開發計畫書(SDP)中「軟體開發規劃」章節之內容。

4、安裝指南

(1)安裝步驟

以文字及圖片範例詳細說明安裝過程，及每個步驟或選項對整個軟體安裝有何影響。例如，安裝過程中建立軟體管理者ID及Password時，要清楚地讓安裝人員瞭解，所輸入的ID及Password對未來使用時之存取控制及系統操作有何影響，並提醒管理者牢記這些資料。

(2)安裝之注意事項

以文字及圖片範例詳細說明安裝過程之注意事項，例如，軟體安裝完成後，是否要重新開機，或安裝B軟體前，應該先安裝A軟體，或提昇A軟體版本。

5、操作描述

以文字及圖片詳細說明該軟體各個功能、操作方法及步驟，例如，關閉檔案時，軟體會出現“是否存檔”及“取消”的對話視窗，而選擇前者或後者，各會有那些不同的結果。

6、疑難排除

(1)線上錯誤訊息

顯示錯誤訊息給使用者，以便將錯誤訊息回報給程式開發人員。例如，出現錯誤訊息，讓程式開發人員瞭解網路連線失敗的原因，是在主機端或是在客戶端，抑或起因於網路流量過於擁塞。

(2)Help操作系統書面說明(B、C)

以文字及圖片提供詳細書面Help操作系統，輔助使用者操作該軟體。

(3)線上Help操作系統

從書面Help中選擇使用者可能較常遇到的問題，放置於線上Help操作系統中，即時地在線上輔助使用者操作該軟體。

(4)FAQ(C)

列出一般使用者操作該軟體時，常遇到的問題及解答，以利使用者排除所遭遇的困難。例如，軟體出現亂碼時，應該如何勾選選項，或如何安裝中文化軟體，方可支援中文介面。

7、維護與管理

(1)存取控制(Access Control)

說明一般使用者、系統管理者或其它等級之使用者，擁有那些存取功能或限制。例如，一般使用者，不能存取管理者專屬的檔案及某些屬於系統管理者的設定功能，表4.6.1為地震監測報表查詢作業權限一覽表的例子。

(2)資料備份

說明備份資料之操作步驟及時機，例如，每天下午五點鐘匯出或輸出某些格式的檔案到某備援裝置，而備份的程序為何？

(3)從錯誤中恢復原設定值

說明若此系統發生錯誤導致不能執行，應如何重新啟動，例如，重新載入或重新開機，及如何恢復軟體的預設功能(如重新執行某批次檔)；此外，若需重新安裝，則需有那些步驟方能將備份資料載入新系統。

8、附錄

附錄可為本軟體使用手冊的相關資料，如操作步驟簡表清單。