簡介

歡迎閱讀整季文件!

「文件季別」圖示

與技術文件撰寫者攜手推動開放原始碼協作

目前階段:
「2019 年文件季別」計畫已於 2020 年 3 月 6 日結束。請參閱時間表

《The Season of Docs》計畫的目標是為技術文件撰寫人員和開放原始碼專案提供架構,協助他們共同改善開放原始碼專案說明文件的共同目標。對於剛接觸開放原始碼的技術撰寫者,這項計畫提供機會,為開放原始碼專案貢獻心力。對於已經在開放原始碼進行技術的技術寫入者,這項計畫提供了新的合作方式。「說明文件季」也讓開放原始碼專案有機會 與更多技術寫作社群交流互動

在計畫期間,技術文件撰寫專員花了幾個月與開放原始碼社群密切合作。在專案說明文件中分享自己的技術寫作專業知識,同時學習開放原始碼專案和新技術。

開放原始碼專案會與技術寫入者合作,改善專案的說明文件和程序。他們可以選擇建構新的文件集、重新設計現有文件,或是改善及記錄開放原始碼社群的貢獻程序和新手上路體驗。

我們透過這些活動,讓大眾更容易瞭解開放原始碼文件和技術編寫工作,以及如何合作,進而創造全球開放原始碼社群的美好。

運作方式

以下是整季文件計畫的概要工作流程:

  • 開放原始碼機構申請在今年的文件季度中擔任導師機構。他們可以向申請者提交說明文件專案構想清單。

  • 技術文件撰寫者會查看參與的機構清單,並選擇感興趣的專案。技術文件撰寫專員可能會聯絡相關機構,討論他們的想法。接著,技術文件撰寫專員撰寫專案提案,並提交至 Google 文件季別。

  • 機構已確認要指導的技術寫作專案。

  • 獲選的技術撰寫者需要花幾個月的時間與開放原始碼組織的導師合作,才能完成專案。

  • 計畫結束時,Google 計畫的管理員會宣布已成功完成的專案。

時間軸會顯示涉及步驟的詳細資料和重要日期。

參與者和角色

以下是參與章節的主要人員,以及各小組在計畫中扮演的角色:

  • 機構管理員是參與計畫的開放原始碼機構成員,且擔任所屬機構的文件季度聯絡人。機構管理員提交機構的申請書,以便參加 Google 文件季度、控管機構內的導師、確保技術撰寫專案如期進行、處理文書工作,以及控管導師指導的發布事宜。請參閱管理員指南職責

  • 開放原始碼導師是指參與計畫的開放原始碼組織成員,他們接受這些組織參與今年文件季的導師。導師會與技術撰寫者密切合作,協助確保專案順利進行。請參閱導師指南職責

  • 技術文件撰寫者是全球的技術文件撰寫專員,他們接受今年的文件季度參與這份計畫。申請者應能夠提交角色說明和工作範例,展現相關的技術寫作體驗。請參閱技術文件撰寫者指南責任

  • Google 計畫管理員是執行「文件季度」計畫的 Google 專案經理。

後續步驟

  • 加入season-of-docs-announce的公告郵寄清單,以掌握報名機會和其他重要程式事件的時間。
  • 如要瞭解重要日期和里程碑,請查看時間軸
  • 無論您是技術文件撰寫者或開放原始碼專案成員,只要註冊成為參與者,即可開始
  • 如有任何疑問,請參閱常見問題
  • 如需進一步協助或想參與討論,請與我們聯絡