提要編寫準則
提要和複合提要讓使用者能夠完成一系列的步驟來實現某個目標。
這些準則討論何時使用提要,以及如何妥善撰寫提要。
何時建立提要
提要非常適合會導向實際目標的步驟所組成的作業,例如,建置一個簡單的應用程式。
這個目標必須定義好,使用者才能在提要中的所有步驟都完成之後,見到作業順利完成。
教學指導通常便是好的候選提要,在教學指導中,目標是學習如何執行某項明確的作業。
提要通常包含最多 10 個步驟,可在半小時之內完成。
如果是較大型的作業,請考慮使用複合提要。
何時建立複合提要
當作業大到單一提要不足以說明它,或作業含有多重目標時,便利用複合提要來提供指引。
複合提要可用來說明一系列的作業,其中每項作業都是建置在其繼承根源之上。
何時不使用提要
當一系列簡單步驟便足以解決問題時,最適合使用提要。
提要不是說明系統的替代方案,說明系統可讓您利用搜尋和超鏈結來建立含有豐富圖形且隨機存取資訊的 HTML 頁面。
提要並不適合需要使用者輸入大量文字的作業。
提要的建立準則
- 選擇簡短而有意義的標題。
- 儘可能在提要作業中利用鏈結來存取說明系統,以提供背景資訊或更詳細的資訊
- 如果超出 10 個步驟,請考慮改寫成複合提要。
- 儘可能利用指令來執行簡單而冗長的作業,例如,開啟視景、開啟資源、執行精靈等。另外,也請務必提供不用指令,也能完成相同效果的說明。
- 確定在使用者決定手動執行步驟時,能夠跳過指令
- 對於開啟對話框的步驟,請指定 dialog="true"。這會使提要開在大部分對話框右側的「匣」中。
- 將步驟組織成使用者常常能夠見到成功的符號。如果提要先在 Java 原始程式上進行許多不同的變更,之後再啟動應用程式,它可以重新撰寫成,在程式碼每次改變之後啟動應用程式。
- 確定使用者瞭解他們為什麼執行每個步驟。
- 不要說明多種執行某個步驟的方法,而要挑出最簡單、需要最少說明的方法。
- 利用中斷 (<br/>) 標示來增進可讀性。
- 利用子項目將步驟分解成更小的步驟。
- 並非所有提要都需要子項目。
- 利用動作單字來啟動子項目標籤,如 "Input"、"Expand"、"Select" 等
- 對於子項目標籤,利用引號來識別介面文字,讓使用者能夠區分指示文字與他們需要尋找和互動的介面文字。
- 每個子項目都應該負責一項不可分割的作業,例如,輸入某個值。
- 一律在提要的最後步驟中,加上 <onCompletion> 元素。
- 利用不同的提要視圖大小來測試提要。
- 在開啟錯誤日誌視圖的情況下測試提要,以便查看日誌是否寫入了任何警告。
複合提要的建立準則
- 複合提要所包含的各項作業,應該可以用單一共用佈景主題關聯起來。
- 複合提要內的每項作業都應該有一個定義好的目標。
- 利用 <onCompletion> 元素來辨識作業順利完成。
- 作業名稱應該簡短扼要。
- 複雜問題可以利用建置在繼承根源之上的作業來解決。
- 如果作業是選用的,請使用 skip="true"。
- 為了一致,請確定簡式提要的簡介和名稱符合複合提要所指定的簡介和名稱。
- 關於作業說明,請利用粗體格式來清楚識別介面文字。
- 只在作業啟動順序非常重要時,才應使用序列。
相關鏈結
使用提要
使用複合提要
簡式提要
複合提要