公開“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 開源專案風格指南》中文版Go
- Google JavaScript 風格指南GoJavaScript
- Google JavaScript 程式碼風格指南GoJavaScript
- libusb開發者指南
- Google 2019開發者大會Go
- Google C++ 程式設計風格指南:命名約定GoC++程式設計
- Android 在 Google 開發者大會上釋出了哪些更新? | Google 開發者大會 2018AndroidGo
- Google Play 開發者賬戶被封Go
- Google Chrome 開發者工具漏洞利用GoChrome
- Google Play 助力更多開發者成功Go
- 【開發者福利】公開API的使用API
- Google 開發者網站常用網址Go網站
- Google I/O 2022開發者大會Go
- 平庸開發者的生存指南
- Json風格指南JSON
- Google開發者大會:為中國開發者和消費者推出新的工具Go
- [譯] Google JavaScript 風格指南中 13 個值得注意的細節GoJavaScript
- 2018 Google 開發者大會精彩回顧Go
- 帶你逛 2019 Google 開發者大會Go
- Google 2020開發者大會Flutter專題GoFlutter
- 開源Android容器化框架Atlas開發者指南Android框架
- javacv教程文件手冊開發指南匯總篇Java
- OpenHarmony開發者文件開源計劃,快快加入吧
- Sentry 開發者貢獻指南 - SDK 開發(事件負載)事件負載
- Sentry 開發者貢獻指南 - SDK 開發(效能監控)
- ModStart開發者文件-系統架構架構
- 中國 2018 Google 開發者大會!今起開放報名Go
- Google 開發者大會 2018 實錄 — TensorFlow篇Go
- 2022 Google 遊戲開發者峰會來啦!Go遊戲開發
- WWDC 2018:寫給 OpenGL 開發者們的 Metal 開發指南
- Sentry 開發者貢獻指南 - 配置 PyCharmPyCharm
- Sentry 開發者貢獻指南 - Feature Flag
- 給Android開發者Flutter上手指南AndroidFlutter
- JavaScript編碼風格指南JavaScript
- RayWenderlich 官方 Swift 風格指南Swift
- JavaScript 編碼風格指南JavaScript
- TensorFlow 主題演講 | Google 開發者大會 2018Go
- 多元共進|2023 Google 開發者大會全解析Go
- Google Play 更新一覽 | 2021 Android 開發者峰會GoAndroid