技術文件撰寫指南

目前階段：
已公布結果。請參閱時間軸。

這份指南旨在協助技術文件撰寫人員，與有意加入 Google 文件季計畫的合格機構合作。

你是否應該參加 Google 季節性文件計畫？

請參考以下問題，瞭解你是否有意與 Google 季度文件計畫中獲准的機構合作。

  • 您是否具備技術文件撰寫技能和經驗？Google 文件季的目的並非教導基本技術寫作技能，您是否有動力並能做好時間管理？
  • 在計畫進行的六個月內，您是否有時間參與？專案的規模不盡相同，但介於計畫執行期間每週約 5 至 30 小時的範圍。
  • 您是否有興趣累積開放原始碼工作經驗？您是否願意花時間瞭解專案流程和社群規範？
  • 您是否願意與機構管理員合作，精進他們的專案提案、制定時間表、評估及整理指標，並協助整個機構瞭解技術寫作的價值？

您也必須符合計畫資格規定，包括能夠建立 Open Collective 帳戶。請注意，你必須符合法律規定，才能收取在居住地執行的工作所得。影視季節計畫管理員無法提供稅務建議，也無法回答有關工作資格的相關問題。

如果你是技術寫作高手，並參加 Google 文件季，我們會支付報酬給你，讓你在協助專案透過更優質的文件解決重要需求的同時，累積開放原始碼工作經驗。

以技術文件撰稿人的身分參與 Google 文件季節計畫

探索階段

機構申請截止日期為 2023 年 3 月 24 日 18:00 (世界標準時間)。我們建議技術作家盡早著手探索可能的專案。不過，機構可以在 2023 年 5 月 10 日 18:00 (世界標準時間) 之前的任何時間，選擇合作的技術作家。

  • 尋找你感興趣的專案
    • 請直接按照 Google 季度文件計畫網頁上的說明，與開放原始碼機構聯絡，或是查看 Google 季度文件 GitHub 存放區，找出有意願參與 Google 季度文件計畫的機構。您也可以在 Write the Docs Slack 的 #season-of-docs 頻道中，找到有興趣的機構。
    • 選擇專案的方式：
      • 選擇您熟悉或感興趣的語言 (例如 JavaScript 或 C) 的專案。
      • 選擇您感興趣的技術或領域專案，例如機器學習、開放科學或機器人。
      • 依據社群友善程度選擇專案！瀏覽他們的討論區、查看貢獻者的社群媒體帳戶 (如果他們在該帳戶中談論自己的專案)，並查看他們的 onboarding 文件 (如有)。
      • 如果您想使用的專案不在專案清單中，請與該專案聯絡，要求對方考慮提出申請！
  • 查看專案的提案頁面
    • 找到 3 到 5 個可能的專案後，請查看每個專案的提案頁面
    • 請透過專案提供的意見回饋和討論管道，提出問題、提供意見和建議
  • 直接向機構提交利益聲明。在意願書中，請說明如何達成機構的專案提案中所列目標。
    • 使用 Google 季度文件意願書範本。越短越好！
    • 請按照該機構的「Ideas」頁面上提供的指示，提交您的意願書。如果機構列出任何特殊要求，請務必在聲明中表明您符合這些要求。
    • 提交意願書即表示你同意遵守該組織的行為準則，以及 Google 的「Docs 季節」行為準則。

申請階段

  • 等候 Google 文件季節公布通過審查的機構名單：
    • 如果機構想與你合作或進一步討論你的意願聲明，就會直接與你聯絡。
    • 機構不僅限在機構申請期限前提交利益說明的技術撰稿人合作。接受後，他們可能會要求進一步的興趣聲明。機構必須在世界標準時間 2023 年 5 月 10 日 18:00 前選擇技術文件撰稿者。
    • 機構不需要針對未成功的興趣聲明提供意見回饋。

專案開發階段

  • 與機構合作，建立時間表，包括可交付成果和截止期限。

最終評估和個案研究階段

  • 與機構合作，提供最終評估和案例研究所需的資訊。