Technical Writing: Top 10 tips for Microsoft style and voice

這是 Claude 翻譯的 Top 10 tips for Microsoft style and voice,會寫這篇文章是因為 Hugo 文檔實在是太爛了因此才有動機研究「怎麼寫好文檔」。

以下開始翻譯。

Microsoft 風格與語氣的十大要點 - Microsoft 風格指南 | Microsoft Learn

破折號永遠被禁止使用。它沒有任何好處,只會帶來更多雜訊與爭議。

用更少的字表達更大的想法

我們的現代設計以簡潔俐落為核心。愈短愈好。若想進一步了解,請參閱〈品牌語氣〉。

範例 將這句替換:如果您已準備好為貴組織採購 Office 365,請聯絡您的 Microsoft 客戶代表。

改為這句:準備好購買了嗎?請聯絡我們。

寫得像說話一樣

寫得像說話一樣。大聲朗讀您的文字。避免使用術語或過於複雜、技術性的語言。應該讀起來像一場友善的對話。若想進一步了解,請參閱〈品牌語氣〉。

範例 將這句替換:無效的 ID

改為這句:您需要一個像 someone@example.com 這樣格式的 ID

展現親和力

使用縮寫形式,例如「it's」、「you'll」、「you're」、「we're」和「let's」。若想進一步了解,請參閱〈使用縮寫形式〉。

範例 將這段替換:為了幫助您避開塞車、記住紀念日,以及做更多的事,Cortana 需要知道您感興趣的事物、您行事曆上的內容,以及您正在與誰一起做事。

改為這段:為了幫助您避開塞車、記住紀念日,以及做更多的事,Cortana 需要知道您感興趣的事物、您行事曆上有什麼,以及您正在和誰一起做事。

快速切入重點

先說最重要的事。將關鍵字前置以便讀者快速掃視。讓客戶的選擇與下一步一目瞭然。若想進一步了解,請參閱〈可掃視內容〉。

範例 將這段替換:範本提供建立新文件的起點。範本可以包含您經常使用的樣式、格式和頁面配置。如果您經常使用相同的頁面配置和樣式來製作文件,可以考慮建立範本。

改為這段:建立一個包含您最常用樣式、格式和頁面配置的文件範本,即可節省時間。之後每次建立新文件時,只要使用該範本即可。

保持簡潔

只給客戶足夠的資訊,讓他們能有信心地做出決定。刪去每一個多餘的字。若想進一步了解,請參閱〈用字選擇〉。

範例 將這段替換:「插入」分頁上的「建議圖表」指令,會推薦可能適合呈現您資料的圖表。當您想以視覺化方式呈現資料,但又不確定該如何進行時,可使用此指令。

改為這段:使用「插入」分頁上的「建議圖表」指令,為您的資料建立最合適的圖表。

有疑慮時,就不要大寫

預設使用句首大寫格式,也就是只將標題或詞語的第一個字,以及專有名詞或名稱大寫。不要使用標題式大寫(Like This)。若想進一步了解,請參閱〈大寫規則〉。

範例 將這些替換:Find a Microsoft Partner、Office 365 Customer、Limited-Time Offer、Join Us Online

改為這些:Find a Microsoft partner、Office 365 customer、Limited-time offer、Join us online

在正確的位置使用結尾標點

標題、子標題和 UI 標題結尾不要使用句點或冒號。若想進一步了解,請參閱〈標點符號〉、〈標題〉和〈清單〉。

範例 將這句替換:移動磚。 1. 按住磚不放。

改為這句:移動磚 1. 按住磚不放。

記得最後的逗號

在三個或以上項目的清單中,連接詞之前要加上逗號。(這個位於連接詞前的逗號,即牛津逗號或序列逗號。)若想進一步了解,請參閱〈逗號〉。

範例 將這句替換:Android、iOS 和 Windows(原文未於連接詞前加逗號)

改為這句:Android、iOS,和 Windows

別把空格用得太隨便

在句點、問號和冒號之後只使用一個空格,破折號前後則不加空格。若想進一步了解,請參閱〈標點符號〉。

範例 將這句替換:使用管線(邏輯性的活動群組)來整合屬於某項工作的活動。(原文以破折號並帶空格呈現)

改為這句:使用管線(邏輯性的活動群組)來整合屬於某項工作的活動。(破折號前後不加空格)

修正無力的寫法

大多數情況下,每個句子都應以動詞開頭。刪去不必要的「您可以」。避免使用「there is」、「there are」、「there were」這類無力的措辭。若想進一步了解,請參閱〈動詞〉和〈用字選擇〉。

範例 將這句替換:您可以跨裝置使用 Office 應用程式,並取得線上檔案儲存與共用功能。

改為這句:將檔案儲存在線上,隨時從您所有的裝置存取,並與同事共用。

原文

Use bigger ideas, fewer words

Our modern design hinges on crisp minimalism. Shorter is always better. To learn more, see Brand voice.

Example Replace this: If you're ready to purchase Office 365 for your organization, contact your Microsoft account representative.

With this: Ready to buy? Contact us.

Write like you speak

Write like you speak. Read your text aloud. Avoid jargon and overly complex or technical language. It should sound like a friendly conversation. To learn more, see Brand voice.

Example Replace this: Invalid ID

With this: You need an ID that looks like this: someone@example.com

Project friendliness

Use contractions like it's, you'll, you're, we're, and let's. To learn more, see Use contractions.

Example Replace this: To help you avoid traffic, remember anniversaries, and in general do more, Cortana needs to know what you are interested in, what is on your calendar, and who you are doing things with.

With this: To help you avoid traffic, remember anniversaries, and in general do more, Cortana needs to know what you're interested in, what's on your calendar, and who you're doing things with.

Get to the point fast

Lead with what's most important. Front-load keywords for scanning. Make customer choices and next steps obvious. To learn more, see Scannable content.

Example Replace this: Templates provide a starting point for creating new documents. A template can include the styles, formats, and page layouts that you use frequently. Consider creating a template if you often use the same page layout and style for documents.

With this: Save time by creating a document template that includes the styles, formats, and page layouts that you use most often. Then use the template whenever you create a new document.

Be brief

Give customers just enough information to make decisions confidently. Prune every excess word. To learn more, see Word choice.

Example Replace this: The Recommended Charts command on the Insert tab recommends charts that are likely to represent your data well. Use the command when you want to visually present data and you're not sure how to do it.

With this: Create a chart that's just right for your data by using the Recommended Charts command on the Insert tab.

When in doubt, don't capitalize

Default to sentence-style capitalization—capitalize only the first word of a heading or phrase and any proper nouns or names. Don't use title-style capitalization (Like This). To learn more, see Capitalization.

Examples Replace these: Find a Microsoft Partner Office 365 Customer Limited-Time Offer Join Us Online

With these: Find a Microsoft partner Office 365 customer Limited-time offer Join us online

Use end punctuation in the right places

Don't use a period or a colon at the end of titles, headings, subheadings, and UI titles. To learn more, see Punctuation, Headings, and Lists.

Example Replace this:Move a tile. 1. Press and hold the tile.

With this:Move a tile 1. Press and hold the tile.

Remember the last comma

In a list of three or more items, include a comma before the conjunction. (The comma that comes before the conjunction is known as the Oxford or serial comma.) To learn more, see Commas.

Example Replace this: Android, iOS and Windows

With this: Android, iOS, and Windows

Don't be spacey

Use only one space after periods, question marks, and colons—and no spaces around dashes. To learn more, see Punctuation.

Example Replace this: Use pipelines — logical groups of activities — to consolidate activities that are part of a task.

With this: Use pipelines—logical groups of activities—to consolidate activities that are part of a task.

Revise weak writing

Most of the time, start each statement with a verb. Edit out you can when it isn't necessary. Avoid weak phrasing like there is, there are, and there were. To learn more, see Verbs and Word choice.

Example Replace this: You can access Office apps across your devices, and you get online file storage and sharing.

With this: Store files online, access them from all your devices, and share them with coworkers.

#文檔撰寫#筆記