技術文件撰寫指南

當前階段:
說明文件開發。請參閱時間表

本指南適用於有興趣與 Google 季節文件計畫中已獲認可的機構合作的技術撰寫者。

您是否願意參加「Google Season of 文件」計畫?

這些問題可協助您瞭解您是否有意與 Google 季節性文件計畫中認可的機構合作。

  • 你具備書寫技術和經驗嗎?Google 第 4 季文件不適合 教導學生基本的寫作技巧你是否有自信且有條不紊?
  • 在這六個月期間,你是否有時間參與這項計畫? 專案規模各不相同,但可在計畫期間每週 5 至 30 小時。
  • 您是否有興趣獲得採用開放原始碼領域的經驗?你是否願意投入時間學習專案程序和社群規範?
  • 您是否願意與機構管理員合作,改進專案提案、制定時程、評估和編譯指標,並協助機構全盤瞭解技術寫作的價值?

您也應符合計畫資格規定,包括能夠建立開放式共同帳戶。您必須能依法收取在居住地營運的資金。Google Season 管理員無法針對您的工作資格提供稅務建議或回答問題。

您是參與「Google 文件季度文件」的專業技術文件撰寫人員可以獲得報酬,除了可以獲得在開放原始碼作業方面的經驗,也能協助專案透過更優質的文件解決重要需求。

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

探索階段

機構申請截止日期為世界標準時間 2024 年 4 月 2 日 18:00。我們建議技術撰寫人員盡早開始探索可行的專案。不過,機構可以選擇在世界標準時間 2024 年 5 月 22 日 18:00 前隨時選擇技術寫入者合作。

  • 尋找感興趣的專案
    • 如要直接聯絡開放原始碼機構,請按照 Google Season of Document 計畫頁面上的指示,直接聯絡開放原始碼機構,或是前往 Google Season of 文件 GitHub 存放區,找出曾表達參加 Google Season of Google 文件的機構。您也可以在「編寫文件 Slack」的 #season-of-docs 頻道中找到感興趣的機構。
    • 選取專案的方法如下:
      • 選擇您熟悉或感興趣語言的專案,例如 JavaScript 或 C。
      • 選擇您感興趣的技術或領域專案,例如機器學習、開放式科學或機器人學。
      • 根據社群友善程度選擇專案!不妨前往他們的論壇參與討論,查看貢獻者的社群媒體帳戶 (如果對方在社群媒體上談論自己的專案),並瀏覽他們的新手指引文件 (如果有的話)。
      • 如果您想處理的專案沒有列在專案清單中,請與該專案聯絡,並請對方考慮提出申請!
  • 查看專案的提案頁面
    • 找到 3 到 5 個可行的專案後,請查看每個專案的提案頁面
    • 請使用專案列出的管道提問、提供意見回饋及建議,方便大家提供意見及進行討論
  • 直接將意願聲明提交給貴機構。表達意願時,我們會說明貴公司如何達成機構專案提案中所設定的目標。
    • 使用 Google 季別文件興趣聲明範本。越短越好!
    • 請按照機構組織提案網頁上的指示提交您的意願聲明。如果組織有列出任何特殊要求,請務必在聲明中列出符合這些要求。
    • 提交您的意願聲明,即表示您同意遵守貴機構的行為準則和《Google 季度文件行為準則》。

應用程式階段

  • 等待 Google 文件季度宣布接受的機構:
    • 合格的組織如果希望與您合作,或進一步討論您的意願聲明,我們將直接與您聯絡。
    • 申請機構只適用於在申請期限前提交興趣聲明的技術撰稿人。對方接受對方接受後,可向使用者徵求進一步的利益。機構必須在世界標準時間 2024 年 5 月 22 日 18:00 前選取技術寫入者。
    • 機構無須對失敗的陳述提供意見。

專案開發階段

  • 請與機構合作制定時程,包括交付項目和期限。

最終評估和個案研究階段

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