Google公開開發者文檔風格指南

Google Word Dart 技術 Google開發者 Google開發者 2017-09-13

文 / Google 技術文案 Jed Hartman

現在,您可以將我們的開發者文檔風格指南用於開放源代碼文檔項目:

https://developers.google.cn/style

Google公開開發者文檔風格指南

多年以來,Google 的技術文案都在根據一份僅限內部使用的編輯風格指南編寫我們的大多數開發者文檔。為了更好地支持參與我們的開放源代碼項目(例如 Kubernetes、AMP 或 Dart)的外部貢獻者,以及提高開發者文檔間的一致性,我們現在將這份風格指南公開。

如果您向這類項目貢獻文檔,可以直接查閱這份有用的指導文檔來了解語態、語氣、用詞,以及其他風格注意事項。它對一些常規問題非常有幫助,例如提醒作者使用第二人稱、現在時、主動語態和連續逗號;也可用於查閱一些非常具體的問題,例如為了保持與 Google Developers 風格一致,應使用“app”還是“application”。

Google公開開發者文檔風格指南

風格指南是一種參考文檔,因此,您可以根據需要查找具體信息,而不用全篇通讀。對於標點、語法和格式問題,您可以在左側導航窗格內進行頁面內搜索,查閱“Commas”(逗號)、“Lists”(列表)和“Link text”(鏈接文本)等章節。

對於具體的術語和短語,您可以查看詞表:

https://developers.google.cn/style/word-list

請密切留意版本說明頁面:

https://developers.google.cn/style/release-notes

瞭解最新動態和變動,並通過這份指南每個頁面上的 Send Feedback(發送反饋)鏈接向我們發送您的意見和建議 - 我們希望收到您的反饋,以便幫助我們不斷完善風格指南。

查看更多文章,請關注『谷歌開發者』官方微信公眾號

相關推薦

推薦中...