1、精選優質文檔-傾情為你奉上精選優質文檔-傾情為你奉上專心-專注-專業專心-專注-專業精選優質文檔-傾情為你奉上專心-專注-專業 密級：內部公開 項目名稱 用戶手冊編寫指南項目編號文件編號SXW_TS_UM_V5.0記錄號項目編號_TS_UM版本號可以是日期正文頁數附件個數（項目經理）批準/日期：文件修訂記錄版本號變化狀態*簡要說明（變更內容和變更范圍）變更日期變更人*變化狀態：C創建，A增加，M修改，D刪除文件審批信息版本號審批人角色審批意見簽字審批日期注：藍色斜體部分為注釋或舉例，實際使用時請去掉。版權聲明版權聲明是保護我們所開發軟件的產權、不使公司利益受到損害的一種方式。在版權聲明中應該包

2、括以下內容：1. 對我們所提供的軟件及用戶手冊的保護聲明2. 對我們的軟件及商標所有權的聲明3. 對我們的用戶手冊中所提到的各種商標的版權聲明4. 我們不對用戶因為使用我們的軟件所造成的損失負責的聲明前 言文檔目標通過閱讀該用戶手冊，用戶應該或能夠達到什么目標。閱讀對象說明誰應該閱讀本手冊，或誰應該閱讀本手冊的哪些部分。關于本手冊如果本系統的用戶手冊(包括管理員手冊、參考手冊等)由多份文檔組成，則首先應該分別簡要介紹這些手冊的情況。然后分別介紹本手冊在每一章所要描述的內容。有助于用戶閱讀和理解本手冊的相關文檔資源，也可以在本段中特別指明。文檔約定說明文檔中字體體例，用什么字體代表什么意義。例如

3、：黑體（粗）代表命令，黑體（常規）代表命令參數等等。說明文檔中的符號代表何種意義。例如：代表提醒等。縮略語和術語列出本文檔涉及的縮略語和術語，并扼要解釋。如果篇幅較大，則可以以附錄和引用文件的形式給出。如何獲得最新版本說明獲得本手冊最新版本的途徑。用戶反饋列出用戶通過什么途徑，提交對產品手冊的意見。目 錄 TOC o 1-3 h z u 簡介描述的用途描述系統的用途，例如用于社區信息管理，諸如此類。系統主要特性扼要描述系統的主要特性（features），例如支持多少種操作系統、支持多少個用戶、支持同時多少個并發等等。不能勝任的工作（本條可選）描述系統不具備的能力，防止用戶誤用。例如用戶可能會用

4、一個網絡包分析和包生成軟件來實施路由功能，顯然這不是應用程序設計的本意。安裝、運行環境描述系統安裝、運行所需的環境。如果安裝和運行的環境不一致，則需要單獨說明。軟件環境列出系統安裝、運行所需的操作系統以及其他輔助的應用程序，例如Windows2003、SQL Server，諸如此類。硬件環境列出系統安裝、運行所需的硬件環境，例如主機的數量、主機的配置（CPU、內存、硬盤、網卡）以及外設（打印機、掃描儀、繪圖儀），諸如此類。其它列出系統安裝、運行所需的其它要求。問題報告和獲得幫助說明用戶反映系統問題以及獲得幫助的途徑，例如email、電話、在線幫助，諸如此類。快速指南（本章可選）以一個或幾個簡單

5、的功能為例，快速地把操作流程演示一遍，讓用戶對系統的界面和功能有一個直觀的印象，減少陌生感。本段篇幅應該盡量短少，幾頁就可能收到不錯的效果。描述的風格以用戶界面截屏圖以及菜單操作為主。系統安裝說明系統的安裝流程。如果系統的安裝前的準備工作對于不同的操作系統有特殊的要求，那么就應該按不同的操作系統分別列出。例如：3.1.Windows 20033.2.Solaris3.3.RedHat Linux AS4windows 2003下安裝（用實際的操作系統名稱來代替標題中的操作系統名稱）安裝前準備說明系統安裝之前需要進行的準備工作，例如檢查操作系統和應用程序的版本、硬盤的空間、用戶在系統中的權限、環

6、境變量的設置，諸如此類。安裝詳細說明系統的整個安裝過程，內容包括：編譯（本條可選）。如果系統是以源代碼方式提供的，則說明如何編譯成可執行的安裝程序。安裝命令。例如菜單命令、命令行命令以及腳本命令等等。安裝過程中的交互。詳細描述每一次交互的輸入、輸出以及所導致的系統狀態的改變。建議用GUI交互的應同時提供截屏圖，用命令行交互的給出命令的完整輸入、輸出結果。安裝驗證測試（本條可選）說明安裝完成以后，執行哪些測試操作來驗證系統已經被正確安裝，詳細說明整個驗證流程和輸出結果。Solaris下安裝（用實際的操作系統名稱來代替標題中的操作系統名稱）安裝前準備安裝正確安裝測試（本條可選）RedHat Lin

7、ux AS4下安裝（用實際的操作系統名稱來代替標題中的操作系統名稱）用戶界面（本章可選）說明用戶界面上的各個菜單項的內容和功能。對于沒有用戶界面的系統，例如后臺服務程序，則不需要在本段說明。如果系統可以在多個操作系統中使用，在不同的操作系統中的用戶界面又不完全一致，則對不一致的地方要單獨說明。簡介簡單介紹用戶界面的特性。開始使用系統說明系統的啟動方式。主窗口扼要描述主窗口菜單的外觀與布局，例如工具欄、狀態欄的位置、文本編輯區的布局，諸如此類。菜單詳細說明每個菜單的內容、功能以及包含的子菜單。說明的方式可以用對一個頂層菜單完全展開的方式來說明。最好配以相應菜單的截屏圖。“文件”（File）菜單“編輯”（Edit）菜單 “幫助”（Help）菜單使用說明如何用本系統開始工作。針對每一項主要的任務（用戶管理、數據管理等等），說明其工作的流程。如果系統可以在多個操作系統中使用，在不同的操作系統中的工作流程又不完全一致，則對不一致的地方要單獨說明。用戶管理用戶登錄新建用戶刪除用戶數據管理常見問題解決列出系統曾經遇到過的常見的問題以及解決方案。如下示例：問題序號問題描述解決方案1不能添加新用戶檢查你登