跳到內容

實用專案:使用者手冊

來自華夏公益教科書

UNIT 4 - ⇑ The Computing Practical Project ⇑

← 系統維護 使用者手冊 寫作質量 →


當你獲得一個新的軟體時,他們通常會提供一個使用者指南,教你如何配置程式、執行主要功能以及解決任何錯誤。這就是我們在這裡要做的。即使你的程式不像你想要的那樣複雜,你仍然可以輕鬆地在這裡獲得最高分。不要把這部分留到最後才做!

標題頁

[編輯 | 編輯原始碼]

這應該看起來像一個真正的使用者手冊,如果有人購買了你的程式,他們會得到這個手冊。它需要是合適的,例如,如果你的程式是一個叫做“Jane's tame receptionist game”的培訓接線員的遊戲,它應該有遊戲的圖片或Jane的圖片,並且以專業的格式設定。在這頁上放你的臉的照片或你家的照片是不合適的。看看你老師可能有的手冊,或者你可能得到的,例如,一個手機,要明智點!

目錄頁

[編輯 | 編輯原始碼]

這應該是你使用者手冊的一個獨立的迷你目錄頁。

簡要介紹和安裝說明

[編輯 | 編輯原始碼]

簡要解釋你的程式的功能和用途,一兩張圖片也不會有害。

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

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

然後,你應該使用螢幕截圖詳細描述安裝產品的步驟。如果你編寫了自己的安裝程式(VS2010 中有一個內建的安裝程式,或者你可以使用 NSIS - Nullsoft Scriptable Install System),那麼顯示每個步驟,否則使用螢幕截圖逐步講解。例如

  1. 插入 CD-ROM
  2. 使用 Windows 資源管理器開啟 CD 資料夾
  3. 將“SweetDatabase”資料夾複製到你的“Program Files”資料夾
  4. ...
  5. 設定新的使用者帳戶
  6. 等等

完整系統的詳細使用說明

[編輯 | 編輯原始碼]

引導使用者完成系統可以執行的 3 個非常詳細和複雜的任務。使用螢幕截圖逐步說明操作。例如

  • 登入並編輯你的詳細資訊
  • 如何玩遊戲

不要僅僅擷取每個窗體的螢幕截圖,然後討論它的功能。我們要求的是一個逐步的指南來實現某些事情。

實際螢幕顯示示例

[編輯 | 編輯原始碼]

4 個螢幕截圖解釋系統不同部分的功能,使用箭頭和文字框進行描述。例如

  • 你的選單頁面
  • 編輯使用者的頁面
  • 顯示遊戲主要元件的遊戲主頁面

錯誤資訊和錯誤恢復過程示例

[編輯 | 編輯原始碼]
預設的錯誤資訊是不可接受的!嘗試自定義你自己的錯誤資訊。

當你構建你的系統時,尤其是在驗證規則周圍,如果你的使用者輸入了錯誤的資料,或者試圖做系統不允許的操作,系統不應該崩潰。它應該提供一個簡單的可讀錯誤資訊,當然不是一個由計算機生成的記憶體轉儲!這部分要求你展示至少 3 種錯誤情況,然後逐步說明如何修復錯誤。錯誤可能包括

  • 使用者名稱和密碼錯誤
  • 欄位中的資料型別錯誤
  • 欄位中的資料超出範圍
  • 欄位中的資料過長
  • 他們在遊戲中死亡
  • 他們回答問題錯誤
  • 他們嘗試載入不存在的檔案
華夏公益教科書