技術文件撰寫指南

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

本指南旨在協助技術文件撰寫專員與 Google 系列文件計畫認可的機構合作。

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

這些問題能幫助您瞭解您是否有興趣與 Google 系列文件計畫認可的機構合作。

  • 您是否具備寫作技術和經驗？Google 系列文件的宗旨不是教導基本的技術寫作技巧。您是否想自己激勵並且有條理？
  • 加入計畫的六個月期間，你是否有時間參與？專案規模各有不同，但計畫期間每週須撥出 5 至 30 小時才能完成專案。
  • 想要獲得使用開放原始碼的經驗嗎？您是否願意投入時間學習專案程序和社群規範？
  • 您是否願意與機構管理員聯絡，以便調整專案提案、擬定時間表、評估及彙整指標，並協助全機構瞭解技術寫作的價值？

您也應該符合計畫資格規定，包括建立 Open Collective 帳戶。請注意，你必須在法律上能夠收受您居住地工作的款項。「文件季度」計畫管理員無法提供稅務建議，也無法回答與你的工作資格相關的問題。

身為參加 Google 搜尋季文件的技術文件工程師，您可獲得使用開放原始碼的經驗，同時運用更優質的文件解決專案關鍵需求。

以技術文件撰寫專員的身分參加 Google 文件季計畫

「探索」階段

機構申請截止日期為世界標準時間 2023 年 3 月 24 日 18:00。我們建議技術文件撰寫專員盡早開始探索可能的專案。不過，機構可以在世界標準時間 2023 年 5 月 10 日 18:00 前，隨時挑選技術撰稿人合作。

  • 尋找您感興趣的專案
    • 請按照 Google 季度文件計畫頁面上的操作說明直接與開放原始碼組織聯絡，或是前往 Google 季度文件 GitHub 存放區尋找有興趣參與 Google 季刊文件的機構。您也可以在「編寫文件 Slack」中找到 #season-of-docs 頻道，尋找感興趣的機構。
    • 以下提供一些選擇專案的方式：
      • 選擇您熟悉或感興趣的語言，例如 JavaScript 或 C 的專案。
      • 選擇您感興趣的技術或領域專案，例如機器學習、開放式科學或機器人學。
      • 根據社群的友善程度選擇專案！此外，也歡迎您前往論壇，查看貢獻者的社群媒體帳戶 (如果他們在討論自己的專案時有討論的話)，以及查看新手入門文件 (如果有的話)。
      • 如果您想使用的專案沒有列在專案清單中，請與該專案聯絡，要求對方考慮申請！
  • 查看專案的提案頁面
    • 建立 3 到 5 個可能的專案後，請查看每項專案的提案頁面
    • 您可以透過專案列出的管道提問、提供意見及提出建議
  • 直接向相關機構提出意願聲明。透過興趣陳述，您可以展現如何達成機構組織專案提案中所訂的目標。
    • 請使用 Google 整季文件的意願聲明範本。越短越好！
    • 請按照該機構提案頁面上的指示，提交您的意願聲明。如果機構已列明任何特殊規定，請務必在聲明中證明您符合這些要求。
    • 提交興趣聲明，即表示您同意遵守貴機構的行為準則及 Google 系列文件行為準則。

申請階段

  • 等待 Google 系列文件宣布認可機構：
    • 獲準的機構會直接與您聯絡，以便與您合作或進一步討論您的意願陳述。
    • 申請機構不僅限於在機構申請期限前提出利益聲明的技術撰寫專員。他們可能會在接受後要求進一步陳述興趣。申請機構必須在世界標準時間 2023 年 5 月 10 日 18:00 前選擇技術寫入者。
    • 機構不需要針對利益失敗的陳述提供意見回饋。

專案開發階段

  • 與機構合作建立時間表，包括交付項目和期限。

最終評估和個案研究階段

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