自我編輯

預估時間： 10 分鐘

想像一下，你剛寫完一份文檔的初稿。該如何改進它呢？在大多數情況下，完成一份最終發布的文件是一個反覆的過程。將空白頁面變成初稿通常是最困難的一步。寫完初稿後，請務必預留充足的時間來潤飾您的文件。

本單元的編輯技巧可以幫助你將初稿打磨成更清楚傳達讀者所需訊息的文檔。你可以使用其中一種技巧，也可以全部使用；重要的是找到適合你的策略，並將其融入你的寫作日常。

備註： 本單元的內容是以《技術寫作一》的基礎寫作和編輯技巧為基礎，可說是總結了該課程的實用編輯技巧。本單元包含該課程中有用的編輯技巧摘要。如需更詳細的複習，請參閱《技術寫作一》的自學單元。

採用風格指南

公司、組織和大型開源專案通常會採用現有的文件風格指南，或自行撰寫。 Google 開發者網站上的許多文件項目都遵循 Google 開發者文件風格指南。如果您以前從未依賴過風格指南，那麼乍看之下，Google 開發者文件風格指南可能會讓您望而生畏，因為它提供了語法、標點符號、格式和電腦介面文件編寫等主題的詳細指導。您可能會比較想從風格指南的重點提示（highlights）開始。

注意： 對於較小的專案，例如團隊文件或小型開源專案，您可能會發現風格指南中列出的那些重點就已足夠。

風格重點提示列出的一些準則在《技術寫作一》中亦有涵蓋。您可能還記得以下這些技巧：

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

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

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

站在讀者的角度思考

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

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

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

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

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

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

大聲朗讀

根據上下文，您的寫作風格可能會疏遠、吸引讀者，甚至令吳者感到厭倦。一份文件的理想風格在一定程度上取決於目標讀者。例如，一個旨在招募志願者的新開源專案的貢獻者指南可能會採用更非正式、更口語化的風格，而商業企業應用程式的開發者指南可能會採用更正式的風格。

欲檢查您的寫作是否如口語般流暢，請大聲讀出來。注意是否有尷尬的措辭、過長的句子或任何感覺不自然的地方。或者，考慮使用螢幕閱讀器為您朗讀內容。

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

稍後再回頭看

寫完初稿（或第二稿、第三稿）後，把它放在一邊。過一個小時（或兩三個小時）再回頭讀一遍，並嘗試以全新的眼光去讀。您幾乎總能發現可以改進的地方。

改變情境

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

尋找同儕編輯

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

練習

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

Determine whether or not you can simplify your document through the use of terminology that is equivalent but relatively shorter in length and therefore more easily comprehensible by your audience. It's important to make sure your document is edited before it is seen by your audience, which might include people that are less or more familiar with the matter covered by your document. The first thing you need is a rough draft. Some things that can help make your document easier to read are making sure you have links to background information, and also checking for active voice instead of passive voice. If you have long sentences you can consider shortening them or implementing the use of a list to make the information easier to scan.

判斷您是否可以透過使用等效但相對較短的術語來簡化文件，從而使您的讀者更容易理解。請務必確保文件在被讀者看到之前進行編輯，您的受眾可能對文件所涵蓋的內容不太熟悉，也可能比較熟悉。您首先需要準備一份草稿。一些有助於提高文件易讀性的措施包括：確保文件中包含背景資訊的連結，並檢查是否使用主動語態而非被動語態。如果句子較長，可以考慮縮短句子或改成清單項目，以便快速瀏覽資訊。

下一單元： 組織大型文件