重點回顧

預估時間： 1 分鐘

《技術寫作二》涵蓋了以下技術寫作的中級課程：

• 採用風格指南。
• 站在受眾的角度思考。
• 大聲朗讀文件（給自己聽）。
• 在撰寫完草稿後，過一段時間再回頭看文件。
• 尋找一位好的同儕編輯。
• 撰寫文件大綱。或者，自由寫作然後再組織。
• 介紹文件的範圍和任何先決條件。
• 偏好以任務為基礎的標題。
• 逐步揭露資訊（在某些情況下）。
• 考慮在建立插圖之前先寫圖說。
• 限制單一圖形中的資訊量。
• 透過在圖說中描述重點或在圖片中添加視覺提示，將讀者的注意力集中在圖片或圖表的相關部分。
• 建立簡潔易懂的範例程式碼。
• 程式碼註解應簡短，但清晰度優先於簡潔。
• 避免對明顯的程式碼撰寫註解。
• 將您的註解精力集中在程式碼中任何不直觀的部分。
• 不僅提供範例，還提供反例。
• 提供展示不同複雜程度的程式碼範例。
• 養成持續修訂的習慣。
• 為不同類型的使用者提供不同類型的文件。
• 與讀者已經熟悉的事物進行比較和對比。
• 在教學中，透過範例強化概念。
• 在教學中，註明讀者可能遇到的問題。

恭喜！您已完成《技術寫作二》的課前部分。

《技術寫作二》的課堂部分將幫助您練習技術寫作原則：

• 如果您的組織提供《技術寫作二》的課堂部分，您現在已準備好上這門課。
• 如果您的組織不提供《技術寫作二》的課堂部分，請考慮參加「公告頁面」上列出的免費公開課程之一。