Self-editing

預估時間： 10 分鐘

想像一下，您剛寫完一份文件的初稿。您要如何讓它變得更好？在大多數情況下，完成一份最終發布的文件是一個迭代的過程。將空白頁面變成初稿通常是最困難的一步。寫完初稿後，請務必預留充足的時間來潤飾您的文件。

本單元中的編輯技巧可以幫助您將初稿轉變為更能清晰傳達受眾所需資訊的文件。您可以使用一個技巧，也可以全部使用；重要的是找到適合您的策略，然後將該策略納入您的寫作習慣中。

注意： 本單元中的技巧建立在《技術寫作一》的基本寫作和編輯技能之上。本單元包含該課程中有用的編輯技巧摘要。如需更詳細的複習，請參閱《技術寫作一》的自學單元。

採用風格指南

公司、組織和大型開源專案通常會為其文件採用現有的風格指南或自行編寫。Google Developers 網站上的許多文件專案都遵循 Google 開發者文件風格指南。如果您以前從未依賴過風格指南，乍看之下，Google 開發者文件風格指南可能會讓您感到有些望而生畏，它提供了關於語法、標點符號、格式和文件化電腦介面等主題的詳細指導。您可能更喜歡從採用風格指南重點開始。

注意： 對於較小的專案，例如團隊文件或小型開源專案，您可能會發現重點就足夠了。

風格指南中列出的一些準則在《技術寫作一》中有所涵蓋。您可能會回想起以下一些技巧：

  • 使用主動語態來明確誰在執行動作。
  • 將連續步驟格式化為編號清單。
  • 將大多數其他清單格式化為項目符號清單。

風格指南引入了許多其他在撰寫技術文件時可能很有用的技巧，例如：

  • 使用第二人稱寫作。將您的受眾稱為「您」，而不是「我們」。
  • 將條件放在說明之前，而不是之後。
  • 將程式碼相關文字格式化為程式碼字體。

站在受眾的角度思考

您的受眾是誰？退一步，嘗試從他們的角度閱讀您的草稿。確保您的文件目的明確，並為您的讀者可能不熟悉的任何術語或概念提供定義。

為您的受眾勾勒一個人物誌會很有幫助。人物誌可以包含以下任何屬性：

  • 一個角色，例如「系統工程師」或「品管測試員」。
  • 一個最終目標，例如「還原資料庫」。
  • 一組關於人物誌及其知識和經驗的假設。例如，您可能會假設您的人物誌是：
    • 熟悉 Python。
    • 執行 Linux 作業系統。
    • 習慣遵循命令列的說明。

然後，您可以根據您的人物誌來審閱您的草稿。告知您的受眾您所做的任何假設會特別有用。您還可以提供資源連結，如果他們需要複習特定主題，可以在其中了解更多資訊。

請注意，過度依賴一個（或兩個）人物誌可能會導致文件過於狹隘，無法對大多數讀者有用。

如需複習和更多關於此主題的資訊，請參閱《技術寫作一》中的「受眾」自學單元。

大聲朗讀

根據上下文，您的寫作風格可能會疏遠、吸引甚至讓您的受眾感到無聊。給定文件的所需風格在一定程度上取決於受眾。例如，一個旨在招募志願者的新開源專案的貢獻者指南可能會採用更非正式和對話式的風格，而商業企業應用程式的開發者指南可能會採用更正式的風格。

要檢查您的寫作是否具有對話性，請大聲朗讀。注意是否有尷尬的措辭、過長的句子或任何感覺不自然的地方。或者，考慮使用螢幕閱讀器為您朗讀內容。

有關調整寫作風格以適應受眾的更多資訊，請參閱「風格和作者語氣」。

稍後再回頭看

寫完初稿（或第二稿或第三稿）後，將其擱置一旁。一小時（或兩三小時）後再回頭看，並嘗試以全新的眼光閱讀。您幾乎總會注意到可以改進的地方。

改變情境

有些作者喜歡列印他們的文件並用紅筆審閱紙本。在審閱自己的作品時改變情境可以幫助您找到可以改進的地方。對於這個經典技巧的現代版本，將您的草稿複製到不同的文件中，並更改字體、大小和顏色。

尋找同儕編輯

就像工程師需要同儕審閱他們的程式碼一樣，作者需要編輯來為他們的文件提供回饋。請某人審閱您的文件並給予您具體、建設性的評論。您的同儕編輯不需要是您文件技術主題的領域專家，但他們確實需要熟悉您遵循的風格指南。

練習

如果您正在處理一份文件，請使用本頁面中的一個或多個技巧來改進它。如果您沒有正在進行的文件，請編輯以下段落。

判斷您是否可以透過使用等效但相對較短的術語來簡化您的文件，從而使您的受眾更容易理解。在您的文件被您的受眾看到之前進行編輯很重要，您的受眾可能包括對您的文件所涵蓋的事項熟悉程度較低或較高的人。您首先需要一份草稿。一些可以幫助您的文件更容易閱讀的方法是確保您有背景資訊的連結，並檢查是否使用主動語態而不是被動語態。如果您有長句子，您可以考慮縮短它們或使用清單，使資訊更容易掃描。

點擊圖示查看答案。

為了幫助您的受眾理解您的文件，請應用這些基本編輯原則：

  • 使用主動語態而不是被動語態。
  • 考慮使用更簡單的同義詞。
  • 包含背景資訊的連結。
  • 將長句子分解為較短的句子或清單。 *

--

Next unit: [Organizing large documents]

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. Last updated 2025‑03‑31 UTC. Send feedback

Last modified: 2025-07-04