技術文件撰寫指南

當前階段:
2021 賽季文件計畫已於 2021 年 12 月 14 日結束,請參閱時間表

本指南適用於有意在 2021 年文件季度計畫中與合格組織合作的技術寫作,

您是否願意參加 2021 年季度文件計畫?

這些問題可協助你瞭解自己是否有興趣在 2021 年「文件季度」計畫中與經認可的機構合作。

  • 你具備書寫技術和經驗嗎?文件季別不適用於教導基本技術寫作技巧。您是否想和有條不紊?
  • 你是否有時間在這項計畫的六個月 (2021 年 4 月至 11 月) 期間參與測試?專案規模各不相同,但可在計畫期間每週 5 至 30 小時。
  • 您是否有興趣獲得採用開放原始碼領域的經驗?你是否願意花時間學習各項專案作業流程和社群準則?
  • 您是否願意與機構管理員合作,改良專案提案、制定時間表、評估和編譯指標,並協助機構全體瞭解技術撰寫內容的價值?

您也應符合計畫資格規定,包括能夠建立開放式共同帳戶。請注意,您必須能夠確保居住地合法收取工作款項。「文件」季系的管理員無法針對您的工作資格提供稅務建議或回答問題。

您是參與「文件季」的專業技術文件寫手,可以獲得開發經驗,除了可以獲得開發開放原始碼的經驗,還能協助專案運用更優質的文件解決重要需求。

以技術文件撰稿者身分參與 2021 年文件季

探索階段

機構申請截止日期為世界標準時間 2021 年 3 月 26 日 18:00。我們建議技術撰寫人員盡早開始探索可行的專案。不過,機構可選擇在 2021 年 5 月 17 日下午 18 點 (世界標準時間) 前與技術撰稿人合作。

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

應用程式階段

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

專案開發階段

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

最終評估和個案研究階段

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