Google 技術寫作課程(中文版)

簡介

Google 技術寫作課程包含四個部分,而這個繁體中文版僅提供 Technical Writing One 和 Technical Writing Two 這兩個課程的翻譯。如下表所示:

原文課程繁體中文版
Technical Writing One技術寫作一
Technical Writing Two技術寫作二
Tech Writing for Accessibility「無障礙」寫作相關議題。此處未提供翻譯。
Writing Helpful Error Messages如何撰寫清楚有用的錯誤訊息。此處未提供翻譯。
授權條款

以下為原課程的授權條款(此中文版亦同):

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

為何要學習技術寫作?

在這個 AI 大時代,技術寫作聽起來好像是一門過時、甚至古老的工匠技藝,對嗎?

也許表面上看來如此,但以我自己在實務工作上的體會,如果在意文件的品質,便不可能對 AI 產生的內容照單全收,而需要人工判斷、揀選、比較、和修改。對我而言,AI 工具是大幅提升工作效率和品質、以及加速學習的好幫手。

而且,就如這個 Google 技術寫作課程開頭的第一句話:

Every engineer is also a writer.

每一位工程師和 IT 從業人員,包括 DevOps、程式設計、系統分析與設計、和專案管理等工作,都免不了需要撰寫技術文件。

這是一項值得學習和投資的技藝。

關於翻譯

此中文版是利用 AI 翻譯工具翻譯之後,再經過人工校閱和排版。

Why?

我很喜歡這個技術寫作教材,因為它簡潔扼要。我相信只要能自行研讀完《技術寫作一》和《技術寫作二》,一定能從中學到許多改善文件的技巧。即便是已經有一些實務經驗的專職 technical writer,也能從中獲取不少靈感。

然而,現在瀏覽器幾乎都有內建翻譯功能,使用者大多也能自行安裝瀏覽器的翻譯插件來即時翻譯網頁內容,為什麼還要製作中文版呢?

主要是因為:

  • 有的電腦環境,瀏覽器的翻譯插件可能無法正常運作,或基於安全政策禁止安裝插件。
  • 經過自己整理和校對,確保翻譯和排版符合我想要的樣子。
  • 強迫自己至少細讀一遍,也方便日後複習。

排版

在官方的原課程當中,練習題的答案預設是不顯示的(摺疊起來),讀者要點擊「查看答案」才會顯示練習的答案。在這個中文版裡面也保留了這樣的排版,如以下範例:

這是練習題的答案。

此外,碰到英文例句時,原則上會保留英文句子,以免失去原意,尤其是討論英文文法的部分。有些地方可能會選擇中英並陳,方便理解句子的意思。

Technical writer 的翻譯

這裡我選擇把 technical writer 翻譯為「技術寫作員」。底下是其他幾個常見的譯法以及為何我不用它們:

  • 技術作家: 這聽起來有點了不得,容易聯想到一般大眾書籍的作家。
  • 技術寫手: 儘管我偏好這個名詞,但在這裡似乎顯得有些不夠正式。

此外,我在某些段落可能會看情況使用「文件撰寫者」或「文件作者」。

會持續更新嗎?

是的,當我發現原始文件有發布新版本,便會更新中文版的內容。

此中文版的製作時間為 2025 年 7 月,而且每個頁面的最底下都有顯示最近一次的更新日期。原文課程的每一個頁面下方也都有標註最近更新日期,故只要比對兩邊的更新日期,就能大致判斷中文版內容是否需要更新。

Feedback

如對此中文版有任何建議或指正,歡迎至 GitHub Issues 提交問題單

開始課程

接著,請從這裡開始學習這門課程:技術寫作一

Last update: 2025-07-21

  前往其他站點: