當前階段:
說明文件開發。請參閱時間表。
本頁針對開放原始碼機構提供實用訣竅,說明如何為 Google - 文件季文件專案提案評估並選擇合適的技術撰稿人。
簡介
開放原始碼機構必須僱用技術撰寫人員來處理他們的提案。機構組織必須自備技術撰稿人。如果您有興趣與參與 Google Season of Docs 的機構合作,技術撰寫人員可能會造訪 Google Season of Document GitHub 存放區,以及 Write the Slack 的 #season-of-docs 管道。
開始這項程序
建議您盡快尋找技術撰稿人,相信未來可能會想要參與 Google 文件系列活動。
評估技術撰寫人員
建議您向考慮的技術寫作人員索取先前開發文件的範例,以便評估這類技術的寫作技巧和經驗。
技術寫作技能與經驗
檢視技術撰寫人員的先前經驗。在理想的情況下,技術撰寫人員應具備軟體業撰寫技術文件的相關經驗。Google 文件季節的目標之一,是讓技術撰寫人員有機會參與以開發人員為主的產品。因此,即使專案是以開發人員的目標對象為主,也不一定要有寫入者俱備 API、SDK 或其他開發人員平台的經驗。
專注於語言和溝通技能。從這個觀點評估技術作家先前的工作。最重要的是:您能瞭解對方寫的內容嗎?如果您想深入瞭解該技術撰寫人員的工作語言,請留意標點符號和標點符號的一致性、拼字是否正確,以及使用清晰易懂的語言。敘事方式簡單還是複雜?每個句子是否很短,還是會持續到 難以理解?
請留意文件設計和版面配置。檢查文件範例的整體版面配置。設計合理嗎?您能否輕易找到文件或說明文件集?是否有重複的內容或存在明顯的落差?
聘用技術文件寫作人員
機構必須僱用技術撰稿人,並在下方連結於 2024 年 5 月 22 日 18:00 (世界標準時間) 前完成技術撰文證明表單。
技術撰寫人員聘僱階段已完成。
在聘僱之前,請務必與技術撰稿人討論薪酬和付款時間表。我們建議機構根據專案里程碑 (包括專案啟動時付款),與技術撰寫人員建立付款時間表。請注意付款日期,因為在整個計畫中只會發生兩次,而是在建立付款排程時支付金額。
注意:如果機構未在 2024 年 5 月 22 日下午 18 點 (世界標準時間) 前僱用技術撰寫人員,並提交技術文件撰寫人員聘僱表單,將不會在首次撥款日期收到資金。