實用專案：使用者手冊

UNIT 4 - ⇑ The Computing Practical Project ⇑
← 系統維護	使用者手冊	寫作質量 →

重要提示：整個部分對於新的規範不再需要。

使用者指南通常與軟體一起提供，以指導使用者如何使用、配置和管理程式。這也是您的課程作業的要求，無論手冊的複雜程度和現實要求如何。在這一部分可以獲得高分，儘管它可能比專案中的其他部分更容易，所以不要把它留到最後一分鐘。

標題頁

使用者手冊的標題頁應該專業且得體，就像您對其他任何使用者手冊的期望一樣。例如，如果您的程式名為“簡的馴服接待員遊戲”，它應該包含遊戲各個階段的高質量螢幕截圖，而不是與之無關或不專業的圖片。如果可能，請嘗試線上或在您的學校/學院找到一些手冊以獲得靈感。

目錄頁

這應該與您的主要報告分開，並且是手冊各部分的小型目錄頁。

簡要介紹和安裝說明

簡要說明您的程式是什麼及其功能；一些高質量的圖片/圖表/螢幕截圖可能會有所幫助。

這還可以包括有關所需硬體和軟體配置的詳細資訊。例如

Windows XP 或更高版本；
1 GB 記憶體；
40 MB 可用硬碟空間；
至少能夠顯示 400x600 解析度的顯示器

然後您應該使用螢幕截圖詳細描述安裝產品的步驟。如果您編寫了自己的安裝程式（Visual Studio 2010 中內建了一個，但另一個選擇是 Nullsoft Scriptable Install System），那麼請顯示每個步驟，否則請使用螢幕截圖逐步描述該過程。例如

插入 CD-ROM；
使用 Windows 資源管理器開啟 CD 資料夾；
將“SweetDatabase”資料夾複製到您的“Program Files”資料夾；
...
設定新的使用者帳戶；
等等。

詳細描述整個系統的使用

引導使用者完成系統可以執行的三個任務（具有合理的複雜度）。使用分步說明和螢幕截圖。此類任務可能包括

登入並編輯您的詳細資訊；
如何玩遊戲；
等等。

不要僅僅擷取每個表單的螢幕截圖並討論其功能。您需要包括如何完成任務的分步指南。

實際螢幕顯示示例

包括四個螢幕截圖，使用箭頭和文字框來幫助您的描述，解釋系統不同部分的功能。例如

選單頁面；
編輯使用者詳細資訊的頁面；
顯示遊戲元件的主遊戲頁面。

錯誤訊息和錯誤恢復程式示例

在構建系統時，特別是在驗證規則方面，如果使用者輸入了不正確的資料或嘗試執行系統不允許的操作，系統不應該崩潰。它應該提供一個易於理解的（易於閱讀的）錯誤訊息。這當然不應該是一個計算機生成的記憶體轉儲或看似隨機的十六進位制錯誤程式碼！此部分要求您至少顯示三種不同的錯誤情況，然後是分步指南或解釋如何修復錯誤。錯誤可能包括

使用者名稱和密碼不正確；
欄位中的資料型別不正確；
欄位中的資料超出範圍；
欄位中的資料太長；
嘗試載入不可訪問的檔案（不存在、許可權無效等）。