專業與技術寫作/說明
許多人習慣於遵循書面說明，但大多數人從未為其他人編寫過說明。在許多專業角色中，您可能需要編寫說明。雖然有些說明可能很簡單，但其他說明可能更復雜，需要更長時間才能完成。因此，瞭解如何編寫有用的說明非常重要。
編寫有用的說明可能很困難，因為人們以不同的方式閱讀和理解事物。例如，有些人是視覺學習者，可能難以遵循書面說明。讀者也擁有不同的教育背景。在編寫說明時，使用簡單、邏輯的風格和格式很重要。
在編寫說明時，避免使用說服性語言，並採用基於任務的方法。保持寫作簡潔明瞭，並專注於使使用者成功完成任務。
一般來說，請遵循以下指南
簡潔性和清晰性
保持句子簡短易懂。儘可能使用常用術語。避免使用習語、俚語、行話、暱稱、縮寫和縮略語。如果您確實使用了可能陌生或令人困惑的術語，請在該術語首次出現在說明中時對其進行清楚定義。
受眾
在編寫說明時瞭解您的受眾非常重要，這樣您就可以包含所有必要的資訊並排除不必要的資訊。瞭解您的受眾可以讓您根據受眾可能擁有的背景、經驗和對主題的熟悉程度做出合理且明智的假設。例如，如果您正在為當地公共圖書館的一個老年人小組編寫說明，那麼假設他們熟悉開啟特定軟體應用程式的基本知識可能不安全。但是，如果您正在為專業組織內的一組軟體開發人員編寫說明，那麼可以安全地假設他們熟悉開啟特定軟體應用程式的基本知識。
在決定將哪些資訊包含在說明中以及排除哪些資訊時，重要的是要明確識別您的受眾是誰以及他們對說明主題和相關背景資訊的熟悉程度和專業程度如何。
如果受眾可能擁有廣泛的經驗和知識，包括不同程度的熟悉度和專業知識，您可以使用各種技術來保持每組說明簡潔明瞭，並專注於一項單一任務，同時仍然提供必要的資訊。例如，您可以為先決條件資訊建立單獨的說明，併為您的受眾提供快速輕鬆地訪問單獨說明的方法（透過超連結、附錄等）。
圖形
一圖勝千言。新增圖形來傳達您的想法可能比文字本身更有效。附有插圖並伴隨您的書面說明的說明通常非常成功。它增加了理解的額外層次，並允許讀者在出現問題時進行快速瀏覽或故障排除。圖片增加了額外的維度，可以讓您的讀者形象地看到最終產品。此外，在使用圖形時，您應該注意那些視覺學習者，並調整圖形。
雖然圖片很棒，但您必須注意不要包含令人困惑或與實際書面說明無關的照片或插圖。如果您將一張糟糕的圖片與您的說明配對，您可能會在讀者試圖理解您的意思時造成壓力或引入困惑。
此外，在拍攝照片時，請確保區域光線充足，照片清晰明亮。黑暗或模糊的照片通常難以理解。注意每次都以相同的方位拍攝主題，以避免混淆，並考慮使用三腳架。
在說明中使用圖片時，大小也很重要。一張太小而無法看到的圖片和一張模糊的圖片一樣無用。
為了強大且易於理解，您每個步驟的文字和圖形應清楚地與說明的該步驟相關聯。
格式
請記住，讀者將在閱讀說明的同時實際執行任務。因此，您不應使用密集的小塊、難以辨認的文字。確保為您的說明頁面建立一個設計和佈局，以實現易讀性並增加美學質量。保持頁面簡單，但具有明確的層次結構，將有助於讀者完成說明步驟。
在設計頁面時，堅實的層次結構對於掃描能力至關重要。使用粗體標題、斜體和羅馬數字將幫助讀者輕鬆找到自己的位置，並有助於整體視覺效果。
順序
您的說明必須以邏輯順序進行計劃。確保在首頁上清楚地說明問題。在您的問題之後，是一組詳細說明如何解決所提問題的具體步驟。技術說明必須以邏輯模式流動。例如，在組裝桌子時，如果您在所有螺絲都到位之前就進行最後的修飾，那將不是一件好事。如前所述，還應在必要時新增清晰的圖形以說明操作。請記住，一圖勝千言。
測試和驗證
我們都知道編寫說明很難，有時在紙上看起來不錯，但當你真正嘗試將說明付諸實踐時，你可能會發現你的措辭對其他人毫無意義。請記住，對您來說可能是常見或顯而易見的事情可能會讓您的讀者感到困惑，因此請了解您的受眾。除了對自己進行說明測試之外，還要讓一個對您的產品一無所知的人進行測試。這被稱為可用性研究。記錄有效和無效的內容，然後根據情況修改說明。從長遠來看，測試說明的人越多，最終說明就越有效。
將您的說明定製為目標受眾可能是您的寫作過程中最困難的任務之一。在開始寫作過程之前，您需要確定您的受眾是誰，以及如何定製您的說明以使其儘可能易於理解。為了幫助您做到這一點，您可以問自己一些問題
- 您的受眾成員可能有什麼樣的背景，他們可能擁有哪些先驗知識？這將幫助您確定您需要在說明中包含哪些資訊或不包含哪些資訊。
- 他們的需求/興趣是什麼？
- 他們的統計資料將如何影響您的寫作？如果您的受眾大多數來自與您不同的統計資料，您需要考慮語言問題，並確保圖形清晰。
- 您的受眾是否有差異性？如果您的受眾由具有不同背景的人組成，您的寫作應針對大多數受眾，您也可以考慮在附錄中新增其他資訊。
根據您對上述問題的答案，您可以透過多種方式確保您的說明對讀者儘可能清晰。
- 新增讀者為了理解您的說明而需要的資訊（例如提示、旁註），並確保沒有關鍵資訊丟失。
- 不要新增不必要的資訊；它可能會讓您的讀者感到困惑或誤導。
- 確保文件符合您的受眾水平。
- 新增示例/圖形。圖形對讀者非常有用。
- 組織清晰。缺乏組織會造成混亂和沮喪。
以下部分描述了一組說明的一般結構的不同部分。要包含哪些部分將根據說明的複雜程度而有所不同。您的文件可能包含以下任何部分
- 簡介
- 裝置描述
- 必要的材料和裝置
- 步驟
- 視覺輔助
- 故障排除
您在簡介中包含的內容將取決於您的說明的用途以及誰將使用它們。在任何情況下，簡介都應該簡短，但仍然要有資訊量。簡介可以包含以下任何或所有部分
- 主題/目標：這裡您應該指出將要解釋的特定任務以及程式的結果是什麼。
- 目標讀者：您可能希望確定說明的目標讀者是誰，以及讀者是否需要額外的知識或背景才能完成任務。
- 範圍：這將幫助讀者瞭解說明是否能夠幫助他們完成他們想要完成的任務。
- 組織：為讀者提供對說明其餘部分的概覽可以幫助他們更容易地理解它們。本節也可以放在範圍之下。
- 安全：您有責任告知讀者在完成任務時可能發生的任何危險或危害。您需要以清晰易懂的方式顯示警告。
如果讀者必須使用裝置來操作或維修裝置，您可能需要包含裝置的描述。
提供讀者完成任務所需的裝置清單，以便他們知道他們是否需要額外的工具或他們可能沒有的物品。用品清單也有助於讀者確保他們擁有所需的所有零件和部件。
本節顯然是說明集中最重要的部分，因為它包含讀者將遵循的實際步驟來完成手頭的任務。有很多方法可以格式化步驟，但大多數使用編號列表。以下是您應該做的事情，以使步驟清晰簡潔
- 用簡潔的措辭編寫每個步驟，以便它易於理解和完成。
- 技巧
- 為讀者提供足夠的資訊來執行步驟，避免冗餘。
- 將步驟放在一個列表中。編號通常效果最好。
- 突出顯示關鍵詞。
- 技巧
- 確保讀者可以快速輕鬆地找到步驟。
- 技巧
- 給步驟編號。
- 在步驟之間跳行。
- 技巧
- 使操作在文字的其餘部分中脫穎而出。
- 告訴讀者如果他們犯了錯誤該怎麼辦。不知道該怎麼辦會導致沮喪，讀者可能會放棄任務。
強烈建議使用圖形和圖片與每個步驟相對應。每個人都有不同的學習習慣；有些人喜歡文字，而另一些人則更喜歡圖片。圖形的存在也允許讀者確保他/她仍在正確的軌道上。在大多數情況下，最好將圖形和文字結合起來。
說明應該包含本節，告訴讀者如果在構建過程中出現問題，或者完成的專案看起來不像預期的結果，該怎麼辦。將此資訊放在表格格式中通常效果最好。
有關說明示例，請訪問 [1] 此網頁包含來自名為 Power Tools for Technical Communication 的教科書中的資訊，作者是 David A. McMurrey。
可用性測試是在準備有效的一組說明中絕對至關重要的一步。完成說明草稿後，重要的是對其進行測試，看看在哪些方面可以改進。應該對每個更新說明草稿的多個測試人員進行可用性測試。以下是進行可用性測試的方法
1. 首先，您應該從代表您目標受眾的群體中選擇您的測試人員。為了挑選出這些特定使用者，您可能需要提出一些初步問題。例如，詢問他們對任務的經驗水平或他們的工作領域。
2. 接下來，您需要選擇如何評估測試人員在完成任務中的表現。有不同的方法可供選擇，但其中一種方法稱為“大聲思考”方法。使用這種方法時，您會要求您的測試人員使用您的說明完成任務，並在他們瀏覽說明的過程中說出他們腦海中的所有想法。在測試人員進行測試時不要提供任何幫助，請禮貌地告訴他們您可以在測試結束後回答他們的問題。當測試人員說出哪些地方令人困惑或困難時，請做筆記。您可以將這些資訊記錄在一個有三個列的圖表中。在第一列中，您將記錄您的測試人員遇到的問題。在第二列中，您寫下每個問題可能的原因。在第三列中，嘗試為問題生成可能的解決方案，或者您可能改變說明以使其更易於理解的方法。確保您要找出的描述性內容。確保設計好測試表格以收集所有與測試相關的資料，以便不會遺漏或放錯任何資料。
3. 測試結束後，檢視您的筆記並請測試人員詳細說明您記錄的問題。這是重要的一步，因為您正在從您的受眾那裡獲得直接反饋。確保您完全理解哪些地方讓他們感到困惑，因為這將幫助您編寫最成功的說明。詢問測試人員您如何在說明的哪些步驟或部分進行更改以使其變得明確。
4. 根據您的發現，編輯和更新您的說明。這樣做之後，它們應該更容易理解，並且更容易讓您的目標受眾遵循。在許多情況下，在完善您的說明時進行一輪或多輪可用性測試是適當的，甚至是有必要的。更多的測試可能在發現第一輪測試中被忽視的問題或由於最初的複雜情況掩蓋了問題方面被證明是有益的。如果時間允許，請確保執行儘可能多的可用性測試輪次。
- 注意：請特別注意您的目標受眾，並確保您擁有代表您的樣本所需的測試人員數量和準確的人口統計資訊。例如，如果您要為“初學者受眾”製作說明，並且測試了“專家”受眾，那麼您的樣本就不會具有代表性。此外，如果您想為一個包含多個年齡、性別和經驗水平的大受眾製作說明，那麼您的樣本需要很大，並代表該人群。
- 如果說明要求測試人員使用雙手（例如系領帶），請考慮使所有說明在不翻頁的情況下可見，以便他們更容易完成任務。
許多人抵制閱讀說明。他們試圖自己弄清楚如何操作產品或執行任務，只有在所有努力都失敗後才會求助於說明。當他們確實閱讀說明時，他們希望立即理解所有內容，而不必閱讀兩次。簡單的設計、樸素的措辭和清晰的說明對於鼓勵讀者關注您的說明或程式至關重要。
在編寫技術文件和說明時，您應該牢記一些風格提示
- 使用大量祈使句、命令句或直接稱呼式寫作。在編寫說明時使用“您”是可以的，因為您是在直接與讀者交談。
- 使用主動語態而不是被動語態。
- 不要遺漏冠詞，如 a、an 和 the。
- 使用動作動詞。
- 確保圖形與描述性文字相匹配，以避免混淆。
- 用步驟標記圖形，例如步驟 17 “…放…”，圖形應該清楚地標記為數字“17”，或者如果一行文字存在多個圖形，則按時間順序寫“17a、17b 等”，或者如果存在不同的檢視，則寫“17 正面、17 背面等”。
- 保持文字簡短但描述性。
- 避免複雜的術語，使用簡單的措辭來確保廣泛的使用者群體能夠理解。
- 使用簡潔的標題和副標題來描述和突出顯示每個部分。
- 在標題周圍留出足夠的空白。
- 突出顯示安全資訊和警告。
- 保持插圖儘可能簡單。