本快速入門是撰寫 Microsoft Learn 上出版物技術內容的簡短指南。 無論您是建立新文件還是更新現有文件，都適用這些指導方針。
最佳做法：
- 即使您需要複製並貼入 Microsoft Word 來進行檢查，也請檢查您文章中的拼字與文法。
- 使用輕鬆友善的語氣，如同您正在和另一個人交談一般。
- 使用簡單的句子。 容易閱讀的句子表示讀者可以快速使用您分享的指導方針。
使用 Microsoft 語氣原則
當我們撰寫 Microsoft Learn 的技術內容時，我們渴望遵循這些原則。 雖然有時可能做不到，但我們必須持續努力！
- 聚焦於目的上：當客戶參閱我們的文件時，他們的內心一定具有某個特定的目的。 在您開始撰寫之前，請明確判斷出目標客戶的類型，以及客戶要嘗試執行的工作內容。 接著，請撰寫文章以協助此類特定客戶執行該項特定工作。
- 使用日常用字：嘗試使用自然些的語言，像是您客戶會使用的字眼。 不用太正式，但是必須維持其文章的技術性質。 提供說明新概念的範例。
- 以一致的風格撰寫：避免使用贅字。 使用肯定句，並避免使用贅字或大量修飾詞。 保持句子簡短明瞭。 讓您的文章成為焦點。 如果工作有限制條件，請將它置於句子或段落的開頭。 此外，請盡量將附註的數目降到最低。 如果使用螢幕擷取畫面可以節省字數，請使用它。
- 讓文章易於概覽：將最重要的事項放在最前面。 使用小節將較長程序分割為更容易管理的步驟群組 （超過12個步驟的程式可能太長。使用螢幕快照來新增清晰。
- 表現同理心：在文章中使用具支持性的正面語氣，並使免責聲明的數目降到最低。 誠實地說明容易使客戶感到挫折的區域。 確保文章著重在對客戶而言重要的內容，不要只是提供技術性說明。
考量當地語系化和機器翻譯
我們的技術文章會翻譯為數種語言，且某些文章會針對特定市場或地理位置進行修改。 讀者也可能會使用網路上的機器翻譯來閱讀技術文章。 因此在撰寫時，請務必將下列指導方針牢記在心：
- 確定文章沒有文法、拼字或標點符號錯誤：這是我們應該做到的基本門檻。 有些 Markdown 編輯器 (例如 MarkdownPad 2.0) 有基本的拼字檢查工具，但最佳作法是將文章的 (已轉譯的 HTML) 內容貼入 Word 來檢查，因為 Word 擁有更健全的拼字和文法檢查工具。
- 儘可能縮短句子：複合句或是一連串的子句會使翻譯變得困難。 如果可以，請在不會使句子過於冗長或讀起來很奇怪的前提下，將句子分成多段。 我們也不希望文章是以不自然的語言撰寫。
- 使用簡單且一致的句子結構：一致性會使翻譯更加容易。 避免括號和旁白，並盡可能讓主詞靠近句子的開頭。 查看一些新發行的文章。 若文章有友善、易讀的風格，請以它為範本。
- 用字和大小寫維持一致：再次強調，一致性很重要。 如果某個字不是句子的開頭或專有名詞，請勿將它大寫。
- 使用「小字」：我們會認為英文中的某些字詞是無關緊要的 (例如 "a"、"the"、"that" 和 "is")，因為我們可以就內容來了解整體的意思。但這類字詞對於機器翻譯而言非常重要。 因此請務必包括這類「小字」。
其他應注意的風格和語氣問題
- 請勿以註釋或旁白中斷步驟。
- 針對包含程式碼片段的步驟，請在程式碼內以註解的形式放入與步驟相關的其他資訊。 這樣可減少讀者必須閱讀的文字量。 重要資訊會複製到程式碼專案中，以在讀者於稍後參考它時，能提醒讀者該程式碼的作用。
- 針對所有標題使用句子大小寫 (僅限英文)。
- 使用 "sign-in" 而不是 "log-in"。
- 如需詳細方針，請參閱 Microsoft 書寫樣式指南。
當地語系化的文件
- 如果您參與本地化的檔，請參閱 全球化參考。
- 如需當地語系化指導方針、技術性出版物之語言風格及使用方式的相關資訊，以及市場特定資料格式的相關資訊，請下載您所使用之語言的樣式指南。
- 請流覽 Microsoft 術語 來搜尋產品特定的已核准術語，或下載您語言中的 Microsoft 術語集合。
- 若要深入了解當地語系化，請參閱 Microsoft 書寫樣式指南中的＜全球通訊＞。
注意
大部分本地化的檔都無法透過 GitHub 編輯或提供意見反應。 若要提供當地語系化內容的意見反應，請使用 https://aka.ms/provide-feedback 表單。