第五章軟體使用手冊
文章推薦指數: 80 %
軟體使用手冊(Software User Manual, SUM)主要目的乃在詳細描述軟體的使用方法,內容包括安裝、操作、疑難排除、維護與管理等細節,讓使用者能依照軟體使用手冊,順利 ...
高麗雯-尤毓婕之軟體品質與系統測試專案
第一章軟體需求規格書
第二章軟體測試計畫書
第三章軟體設計規格書
第四章軟體執行報告
第五章軟體使用手冊
第六章軟體測試報告
PoweredbyGitBook
第五章軟體使用手冊
第五章軟體使用手冊
軟體使用手冊(SoftwareUserManual,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)存取控制(AccessControl)
說明一般使用者、系統管理者或其它等級之使用者,擁有那些存取功能或限制。
例如,一般使用者,不能存取管理者專屬的檔案及某些屬於系統管理者的設定功能,表4.6.1為地震監測報表查詢作業權限一覽表的例子。
(2)資料備份
說明備份資料之操作步驟及時機,例如,每天下午五點鐘匯出或輸出某些格式的檔案到某備援裝置,而備份的程序為何?
(3)從錯誤中恢復原設定值
說明若此系統發生錯誤導致不能執行,應如何重新啟動,例如,重新載入或重新開機,及如何恢復軟體的預設功能(如重新執行某批次檔);此外,若需重新安裝,則需有那些步驟方能將備份資料載入新系統。
8、附錄
附錄可為本軟體使用手冊的相關資料,如操作步驟簡表清單。
resultsmatching""
Noresultsmatching""
延伸文章資訊
- 1R05_軟體維護使用手冊參考範本 - 宜蘭縣政府
R05_軟體維護使用手冊參考範本. 1 文件目的. 本文件主要目的是提供管理員、超級使用員及一般使用員能快速查閱本系統之各. 項功能,並介紹如何操作系統,期引導上述使用 ...
- 2系統操作手冊
使用本系統時,建議瀏覽解析度為1024x768 以上,將獲得較好的使用者經 ... 本瀏覽器操作系統時,頁面可能會與手冊圖例有所差異。 ... 該範例問卷共. 12 道題目 ...
- 3軟體操作範例手冊
此時Workspace Tree 方塊中的. Designs 下多出兩個目錄: Transient1(Sch1) 與Transient1_Data 。 Page 7. 7. GENESYS 操作...
- 4軟體使用說明書 - Brother
軟體. 使用說明書. 對於DCP 用戶;本使用說明書適. 用於MFC 和DCP 型號。請將本使 ... 使用WIA 驅動程式掃描文件( 適用於Windows 相片圖庫和Windows 傳真與掃描...
- 5請問要怎麼寫說明文件呢?? - iT 邦幫忙
請問各位大大在軟體開發時~或者開發後~~ ... 軟體寫的嗎@@?. 要怎麼寫"給一般使用者的說明文件"跟"給IT 人員看的說明文件" ... 較完整的架構,可以去參考ISO文件範例。