公開“Google開發者文件風格指南”
文 / Google 技術文案 Jed Hartman
現在,您可以將我們的開發者文件風格指南用於開放原始碼文件專案:
https://developers.google.cn/style
多年以來,Google 的技術文案都在根據一份僅限內部使用的編輯風格指南編寫我們的大多數開發者文件。為了更好地支援參與我們的開放原始碼專案(例如 Kubernetes、AMP 或 Dart)的外部貢獻者,以及提高開發者文件間的一致性,我們現在將這份風格指南公開。
如果您向這類專案貢獻文件,可以直接查閱這份有用的指導文件來了解語態、語氣、用詞,以及其他風格注意事項。它對一些常規問題非常有幫助,例如提醒作者使用第二人稱、現在時、主動語態和連續逗號;也可用於查閱一些非常具體的問題,例如為了保持與 Google Developers 風格一致,應使用“app”還是“application”。
風格指南是一種參考文件,因此,您可以根據需要查詢具體資訊,而不用全篇通讀。對於標點、語法和格式問題,您可以在左側導航窗格內進行頁面內搜尋,查閱“Commas”(逗號)、“Lists”(列表)和“Link text”(連結文字)等章節。
對於具體的術語和短語,您可以檢視詞表:
https://developers.google.cn/style/word-list
請密切留意版本說明頁面:
https://developers.google.cn/style/release-notes
瞭解最新動態和變動,並通過這份指南每個頁面上的 Send Feedback(傳送反饋)連結向我們傳送您的意見和建議 - 我們希望收到您的反饋,以便幫助我們不斷完善風格指南。
檢視全文及文中連結,請點選文末“閱讀原文”。
相關文章
- Google JavaScript 風格指南GoJavaScript
- Google JavaScript 程式碼風格指南GoJavaScript
- 《Google 開源專案風格指南》中文版Go
- Google Java 程式設計風格指南GoJava程式設計
- Google Python 程式設計風格指南GoPython程式設計
- Google C++程式設計風格指南GoC++程式設計
- Google C++ 程式設計風格指南:類GoC++程式設計
- Google C++ 程式設計風格指南:格式GoC++程式設計
- Google C++ 程式設計風格指南:來自 Google 的奇技GoC++程式設計
- Google C++ 程式設計風格指南:作用域GoC++程式設計
- Google C++ 程式設計風格指南:註釋GoC++程式設計
- Google C++程式設計風格指南(七):格式GoC++程式設計
- Google C++ 程式設計風格指南:命名約定GoC++程式設計
- Google Java 程式設計風格指南 —— 見微知著GoJava程式設計
- Google C++程式設計風格指南(二):作用域GoC++程式設計
- JS 風格指南JS
- JavaScript風格指南JavaScript
- Google C++ 程式設計風格指南:標頭檔案GoC++程式設計
- Google C++ 程式設計風格指南:其他 C++ 特性GoC++程式設計
- Google C++程式設計風格指南(三):C++ 類GoC++程式設計
- Google C++程式設計風格指南(五):命名約定GoC++程式設計
- Json風格指南JSON
- Google C++程式設計風格指南(六):程式碼註釋GoC++程式設計
- Google C++程式設計風格指南(八):規則之例外GoC++程式設計
- [譯] Google JavaScript 風格指南中 13 個值得注意的細節GoJavaScript
- JavaScript編碼風格指南JavaScript
- RayWenderlich 官方 Swift 風格指南Swift
- JavaScript 編碼風格指南JavaScript
- Vue風格指南小結Vue
- JavaScript 程式碼風格指南JavaScript
- Vue 前端程式碼風格指南Vue前端
- 中文寫作排版風格指南
- JavaScript 程式設計風格指南JavaScript程式設計
- CoffeeScript 編碼風格指南
- Python 編碼風格指南Python
- 使用Swashbuckle構建RESTful風格文件REST
- 你聽說過“風格指南驅動開發”嗎?
- Eclipse中使用google程式碼風格EclipseGo