簡介
這是 Google 技術寫作課程(中文版) 的第一部分。此入門課程會告訴您如何撰寫更清晰的技術文件。
目標受眾
您需要具備至少一些英語寫作能力,但您不需要是一位很強的寫作者才能參加本課程。
如果您從未接受過任何技術寫作培訓,本課程非常適合您。如果您曾接受過技術寫作培訓,本課程將提供有效的複習。
學習目標
本課程教您技術寫作的基礎知識。完成本課程後,您將知道如何執行以下操作:
- 一致地使用術語——包括縮寫和首字母縮略詞。
- 識別模糊的代名詞。
- 區分主動語態和被動語態。
- 將被動語態的句子轉換為主動語態。
- 找出主動語態優於被動語態的三個方面。
- 發展至少三種策略,使句子更清晰、更引人入勝。
- 發展至少四種策略來縮短句子。
- 了解項目符號列表和編號列表之間的區別。
- 建立有用的列表。
- 為段落建立有效的引導句。
- 讓每個段落都專注於一個主題。
- 在每份文件的開頭陳述要點。
- 確定您的目標受眾。
- 確定您的目標受眾已經知道什麼以及他們需要學習什麼。
- 了解知識的詛咒。
- 識別和修改慣用語。
- 陳述您文件的範圍(目標)和受眾。
- 將長主題分解為適當的部分。
- 正確使用逗號、括號、冒號、破折號和分號。
- 培養 Markdown 的初學者能力。
成為一名偉大的工程師或偉大的技術寫作人員需要多年的專注練習。本課程將改善您的技術寫作,但不會立即將您轉變為一位偉大的技術寫作人員。
課前和課堂內組成部分
本課程包括以下兩個部分:
- 課前 (pre-class)
- 課內 (in-class)
您目前正在查看課前部分的開頭。
課內部分會加強課前部分所教的課程。話雖如此,單獨的課前課程仍然提供了寶貴的教育經驗。
譯註
原線上課程提供的就是 pre-class 的內容,是一套自學教材。至於 in-class 的內容,指的是有講師帶領,以投影片介紹,並增加一些課堂練習和小組討論。我覺得光是自行研讀 pre-class 的內容就能學到許多技術寫作的基本功。
硬體和網路要求
雖然本課程針對筆記型電腦或桌上型電腦進行了優化,但您也可以在平板電腦或手機上學習本課程。如果您要參加課堂內的部分,請注意您會需要大量打字。
您需要網路連線才能上課。您無法下載課程。本課程不提供實體媒體。
本課程包含一些簡短的影片,所有影片均為選擇性觀看。如果您想跳過影片,那麼您可以在低頻寬的網路連線上學習本課程。
選修單元
我們已將一些單元標記為選修。這些材料不是必需的,但您可能會發現這些材料很有用。
下一單元: 夠用的文法 (選修單元)