目前階段:
2021 年「Docs 季」計畫已於 2021 年 12 月 14 日結束。請參閱時間表。
本頁面提供開放原始碼組織的訣竅,說明如何評估及選出適合 Google 季節性文件專案提案的技術作家。
簡介
開源組織必須聘請技術作家,處理所提案的專案。機構必須自行尋找技術撰稿人。有意與 Google 文件季節參與機構合作的技術作家,可以前往 Google 文件季節 GitHub 存放區,以及 Write the Docs Slack 的 #season-of-docs 頻道。
評估技術文件撰寫人員
建議您向考慮中的技術作家索取先前開發的說明文件範例,這樣您就能專注於評估他們的技術寫作技能和經驗。
技術寫作技能和經驗
檢查技術作家的過往經驗。 理想情況下,技術作家應具備為軟體產業撰寫技術文件的經驗。Google 文件季的目標之一,就是讓技術文件撰稿者有機會參與開發人員導向的產品。因此,即使專案以開發人員為目標對象,作者不一定要具備 API、SDK 或其他開發人員平台的經驗。
著重於語言和溝通技巧。從這個角度評估技術作家先前的工作。最重要的是:您能否理解對方寫的內容?如要深入檢查技術作家的內容,請確認標點符號和用詞是否一致、拼字是否正確,以及語言是否清楚。句子是否簡單或複雜?句子是否簡短?還是會持續講述,直到觀眾難以理解?
留意文件設計和版面配置檢查文件範例的整體版面配置。設計是否符合邏輯?您是否能輕鬆瀏覽文件或文件集?內容是否重複,或是有明顯的空白?