預估時間： 20 分鐘

您如何將大量資訊組織成一份連貫的文件或網站？或者，您如何將現有雜亂的文件或網站重新組織成易於理解且有用的內容？以下策略可以提供幫助：

• 選擇撰寫單一大型文件或一系列文件
• 組織文件
• 新增導覽
• 逐步揭露資訊

何時撰寫大型文件

您可以將資訊集合組織成較長的獨立文件，或一系列較短的相互關聯文件。一系列較短的相互關聯文件通常以網站、維基或類似的結構化格式發布。

有些讀者對較長的文件反應比其他人更積極。考慮以下兩位假設讀者對您正在撰寫的文件所持的觀點：

• 洪先生覺得閱讀長文件很困難且容易迷失方向。他更喜歡使用網站搜尋來尋找問題的答案。
• 羅小姐習慣瀏覽大型文件。她經常使用網頁瀏覽器內建的頁面搜尋功能來尋找當前頁面上的有用資訊。

那麼，您應該將您的資料組織成單一文件還是網站中的一系列文件呢？請考慮以下準則：

• 操作指南、入門概述和概念指南在針對主題新手讀者時，通常以較短的文件形式效果更好。例如，一個完全不熟悉您主題的讀者可能很難記住許多新術語、概念和事實。請記住，您的受眾可能正在閱讀您的文件，以快速且概括地了解該主題。
• 深入教學、最佳實踐指南和命令列參考頁面可以很好地作為較長的文件，特別是針對已經對工具和主題有一定經驗的讀者。
• 一個出色的教學可以依賴敘述來引導讀者在較長的文件中完成一系列相關任務。然而，即使是大型教學有時也可以從分解成較小的部分中受益。
• 許多較長的文件並非設計為一次性閱讀。例如，使用者通常會瀏覽參考頁面以搜尋命令或旗標的解釋。

本單元的其餘部分將介紹可用於撰寫較長文件（例如教學和一些概念指南）的技巧。

組織文件

本節建議了一些規劃較長文件的技巧，包括建立大綱和起草引言。完成文件初稿後，您可以根據大綱和引言進行審閱，以確保沒有遺漏任何您最初打算涵蓋的內容。

撰寫文件大綱

從結構化的高層次大綱開始，可以幫助您對主題進行分組，並確定需要更多細節的地方。大綱有助於您在開始撰寫之前移動主題。

您可能會發現將大綱視為文件的敘述很有用。撰寫大綱沒有標準方法，但以下準則提供了您可能會覺得有用的實用技巧：

• 在要求讀者執行任務之前，向他們解釋他們為什麼要這樣做。例如，以下項目符號說明了關於審核和改進網頁可訪問性的教學大綱的一部分：
  • 介紹一個審核網頁可訪問性的瀏覽器外掛程式；解釋讀者將使用審核報告的結果來修復幾個錯誤。
  • 列出執行外掛程式和審核網頁可訪問性的步驟。
• 將大綱的每個步驟限制為描述一個概念或完成一個特定任務。
• 組織您的大綱，以便您的文件在與讀者最相關時引入資訊。例如，您的讀者在剛開始學習基礎知識時，可能不需要（或不想知道）專案的歷史。如果您覺得專案的歷史很有用，那麼在文件末尾包含指向此類資訊的連結。
• 考慮解釋一個概念，然後演示讀者如何在範例專案或他們自己的工作中應用它。在概念資訊和實用步驟之間交替的文件可以是一種特別引人入勝的學習方式。
• 在開始起草之前，與您的貢獻者分享大綱。如果您正在與一個將審閱和測試您的文件的貢獻者團隊合作，大綱尤其有用。

大綱練習

審閱並更新以下長篇教學引言的高層次大綱。要解決此練習，您可以執行以下任何操作：

• 重新排列現有主題。
• 添加您認為應包含在引言中的任何遺漏主題。
• 刪除您認為與引言無關的任何主題。

## 專案歷史

描述專案的開發歷史。

## 先決條件

列出讀者在開始之前應熟悉的概念，以及任何軟體或硬體要求。

## 系統設計

描述系統如何運作。

## 受眾

描述本教學的目標讀者。

## 設定教學

解釋如何配置您的環境以遵循本教學。

## 疑難排解

解釋如何診斷和解決在學習本教學時可能發生的潛在問題。

## 有用術語

列出讀者需要了解的術語定義，以便遵循本教學。

點擊圖示查看可能的答案。

以下是一個可能的解決方案：

## 受眾

描述本教學的目標讀者。