語態和語調方針
閱讀 .NET 文件的人形形色色,包括 IT 專業人員和開發人員,其想要了解並在日常工作中使用 .NET。 您的目標是建立可協助讀者展開旅程的絕佳文件。 我們的方針有助於達成此目標。 我們的風格指南包含下列建議:
使用交談語調
下列段落是以交談的風格撰寫。 而後續的段落則是以較具學術風格的方式撰寫。
適當的風格
我們希望文件使用交談語調。 當您閱讀任何教學課程或說明時,應該感覺彷彿是在與作者交談。 對您而言,這應該是非正式交談且提供資訊的體驗。 讀者應該感覺彷彿是聽到作者向他們說明概念。
不適當的風格
讀者可能會發現交談風格與處理技術性主題的學術風格之間有所對比。 這些資源很實用,但作者以與我們文件不同的風格來撰寫這些文章。 當讀者在閱讀學術期刊時,他們會發現書寫語調和風格相當不同。 感覺起來彷彿是在閱讀乏味主題的無趣陳述。
以第二人稱撰寫
下列段落使用第二人稱。 而後續的段落則使用第三人稱。 請以第二人稱來撰寫。
適當的風格
當您撰寫文章時,請彷彿是自己直接與讀者對話一般。 請經常使用第二人稱 (如同這兩句所示)。 第二人稱不一定表示使用「您」一字。 請以讀者為直接撰寫對象。 並撰寫祈使句。 告訴讀者您想要他們學到的內容。
不適當的風格
作者也可選擇以第三人稱來撰寫。 在該模型中,作者必須尋找一些用來指涉讀者的代名詞或名詞。 讀者通常可能會發現此第三人稱風格互動性較差,而且讀起來較無趣。
使用主動語態
請以主動語態撰寫您的文章。 主動語態表示句子的主詞會執行該句子的動作 (動詞)。 它與被動語態相反,在被動語態中,句子排列方式是讓句子的主詞被動。 請比較這兩個範例:
編譯器將原始程式碼轉換成可執行檔。
原始程式碼被編譯器轉換成可執行檔。
第一句使用主動語態。 第二句則是以被動語態來撰寫 (這兩句針對每種風格提供另一個範例)。
建議使用主動語態,因為更容易閱讀。 被動語態可能較難閱讀。
在撰寫時考量對詞彙所知有限的讀者
您想要透過文章接觸國際讀者。 許多讀者可能都不是以英文作為母語,且可能尚未學習到您所掌握的英文詞彙。
不過,您仍以技術專業人員為撰寫對象。 您可以假設讀者具備程式設計知識,且理解程式設計術語的特定詞彙。 物件導向程式設計、類別與物件、函式與方法都是熟悉的術語。 不過,並非所有閱讀您文章的人都有正式電腦科技學位。 若使用「等冪」之類的術語時,您可能需要加以定義,例如:
Close()
方法是等幕的,這表示您可以呼叫它多次,其效果會相當於呼叫它一次。
避免使用未來式
在某些非英文的語言中,未來式的概念不同於英文。 使用未來式可能會使您的文件更難閱讀。 此外,使用未來式時,首當其衝的問題是發生時機。 因此,如果您指出「學習 PowerShell 將有益於您」,對讀者而言,首當其衝的問題是何時才會受益? 相反地,直接指出「學習 PowerShell 有益於您」即可。
這是什麼,又有何作用?
當您向讀者介紹新概念時,請先定義概念,再說明概念的實用之處。 讀者必須了解這是什麼,才能了解其優點 (或缺點)。