選取技術文件作者

目前階段:
已發布個案研究。請參閱時間表

本頁面提供開放原始碼組織的訣竅,說明如何評估及選出適合 Google 季節性文件專案提案的技術作家。

簡介

開放原始碼機構必須聘請技術作家,負責處理所提案的專案。機構必須自行尋找技術作家。如果技術作家有意與參與 Google 文件季的機構合作,可以前往 Google 文件季 GitHub 存放區,以及 Write the Docs Slack 中的 #season-of-docs 頻道

開始程序

建議您一想到要參加 Google 文件季,就開始尋找技術文件撰寫專員。

評估技術文件撰寫人員

建議您向考慮中的技術寫作者索取先前開發的說明文件範例,以便評估他們的技術寫作技能和經驗。

技術寫作技能和經驗

  • 檢查技術作家的過往經驗。 理想情況下,技術作家應具備為軟體產業撰寫技術文件的經驗。Google 文件季的目標之一,就是讓技術文件撰稿者有機會參與開發人員導向的產品。因此,即使專案以開發人員為目標對象,作者不一定要具備 API、SDK 或其他開發人員平台的經驗。

  • 著重於語言和溝通技巧。從這個角度評估技術作家先前的工作。最重要的是:您能否理解對方寫的內容?如要深入檢查技術作家的語言,請確認標點符號和用詞是否一致、拼字是否正確,以及語言是否清楚。句子是否簡單或複雜?句子是否簡短?還是會持續進行,直到難以理解?

  • 留意文件設計和版面配置檢查文件範例的整體版面配置。設計是否符合邏輯?您是否能輕鬆瀏覽文件或文件集?內容是否重複,或是有明顯的空白?

聘請技術撰稿人

機構必須聘僱技術作家,並在 2024 年 5 月 22 日 18:00 UTC 前填妥下方連結的技術作家聘僱證明表單。

技術作家招募階段已完成。

在聘用技術作家前,請務必與對方討論薪資薪資發放時間表。我們建議機構與技術作家合作,根據專案里程碑建立付款時間表,包括在專案啟動時支付款項。請注意付款日期 (整個計畫中只會發生兩次) 和金額 (建立付款時間表時)。

注意:如果機構未聘用技術作家,且未在 2024 年 5 月 22 日 18:00 (世界標準時間) 前提交技術作家聘用證明表單,就不會在第一筆撥款日收到款項。