簡介
這是 Google 技術寫作課程(中文版) 的第二部分,旨在協助技術人員提升技術溝通能力。
目標讀者
本課程針對已完成 《技術寫作一》 且仍渴望進一步技術寫作訓練的人士設計。如果您從未接受過任何技術寫作訓練,建議先完成 技術寫作一 再參加本課程。
學習目標
本課程著重於技術寫作的幾個中階主題。完成本課程後,您將能夠做到以下事項:
- 選擇多種不同策略來撰寫初稿,以及撰寫第二稿和第三稿的額外策略。
- 使用多種技巧來偵測自己寫作中的錯誤。
- 組織大型文件。
- 介紹文件的範圍及任何先決條件。
- 撰寫清晰的圖表說明。
- 在技術插圖中選擇適當的資訊密度。
- 在插圖中聚焦讀者的注意力。
- 透過「大局觀」插圖建立背景。
- 有效地修訂技術插圖。
- 創建有用、準確、簡潔、清晰、可重複使用且註解完善的範例程式碼,展示各種複雜度。
- 識別不同的文件類型。
- 描述幾乎任何事物。
- 對初學者抱持同理心,為他們撰寫教學文章。
成為優秀的工程師或技術寫作者需要多年的專注練習。本課程將提升你的技術寫作能力,但不會立即讓你成為優秀的技術寫作者。
課前與課堂內容
本課程包含以下兩個部分:
- 課前(pre-class)
- 課內(in-class)
您目前正在觀看課前部分的開始。
課內部分強化了課前部分所教授的課程。不過,僅靠課前課程本身仍能提供有價值的學習體驗。
譯註
原線上課程提供的就是 pre-class 的內容,是一套自學教材。至於 in-class 的內容,指的是有講師帶領,以投影片介紹,並增加一些課堂練習和小組討論。我覺得光是自行研讀 pre-class 的內容就能學到許多技術寫作的基本功。
硬體與網路需求
雖然本課程最佳化於筆記型電腦或桌上型電腦,但您也可以使用平板或手機修課。如果您參加課堂內部分,請注意您將會大量打字。
您需要網路連線才能參加課程。您無法下載課程內容。課程不提供實體媒介。
課程包含幾段短影片,都是選修內容。如果不看影片,便可以在低頻寬的網路連線下研讀課程內容。
下一單元: 自我編輯