技術文件撰寫指南

目前階段：
2021 年「Docs 季」計畫已於 2021 年 12 月 14 日結束。請參閱時間表。

本指南適用於有意與 2021 年 Google 季節性文件計畫中獲准的機構合作的技術作家。

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

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

  • 您是否具備技術文件撰寫技能和經驗？本季的說明文件課程並非教導基本技術寫作技能，您是否有自我激勵和組織能力？
  • 你是否有時間在計畫的六個月期間 (2021 年 4 月至 11 月) 參與？專案規模各異，但在計畫期間，你每週需要投入 5 到 30 小時不等的時間。
  • 您是否有興趣累積開放原始碼工作經驗？您是否願意花時間瞭解專案流程和社群規範？
  • 您是否願意與機構管理員合作，精進他們的專案提案、擬定時間表、評估及整理指標，並協助整個機構瞭解技術寫作的價值？

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

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

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

探索階段

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

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

申請階段

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

專案開發階段

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

最終評估和個案研究階段

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