常見問題 (FAQ)

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

一般

Google 文件當季是招聘計畫嗎?

不行。如果你想為 Google 工作,請造訪 Google 工作機會網站

Google 文件的季別是否算是實習、工作或任何形式的聘僱?

不會。文件季別是技術文件撰寫人員擔任獨立技術文件撰寫專員的活動,而他們會支付報酬。技術文件撰寫者可以選擇退出這些提示。

為何要參加「文件季別」?

《The Season of Docs》計畫的目標是促進開放原始碼機構與技術撰寫者之間的合作。我們認為這項計畫將:

  • 讓技術文件撰寫者有機會參與開放原始碼專案,並瞭解開放原始碼。
  • 讓開放原始碼專案有機會與技術寫入社群互動,進而提升開放原始碼文件的品質。
  • 提高開放原始碼文件和技術文件的意識。

開放原始碼機構享有的優勢:

  • 與技術文件撰寫專員合作的經驗。
  • 改善文件。
  • 文件季度結束後,建議您持續與技術文件撰寫專員合作。
  • 改善專案記錄流程。
  • 加強在技術寫作社群中對開放原始碼文件的認識。

技術撰寫者享有的好處:

  • 對開放原始碼專案貢獻心力。
  • 具備以開發人員為主的文件和程式碼使用經驗。
  • 工作表現的信用與認可。
  • 需要新增至履歷表的內容。
  • Google 文件季節結束後,持續與開放原始碼專案合作的可能性
  • 提高技術撰寫者在開放原始碼社群的知名度。

技術文件撰寫專員可以處理哪些類型的專案?

不妨參考下列建議:

  • 在平台上建構說明文件網站,由技術撰寫者和開放原始碼導師決定,然後在網站上發布一組基本基本文件。平台範例包括:

  • 重構開放原始碼專案的現有說明文件,藉此提供更優質的使用者體驗,或更易於存取的資訊架構。

  • 撰寫產品或功能的概念總覽或簡介。團隊通常會由團隊由下到上建立技術說明文件,因此結果包含許多細節,但很難全面瞭解產品整體。這時技術文件撰寫專員就能修正這個問題。

  • 針對常見用途建立教學課程。

  • 針對特定工作建立一組專注的使用指南。

  • 建立貢獻者指南,納入相關基本資訊,包括如何成為開放原始碼專案的貢獻者,以及授權協議、提取要求與審查的程序、專案建構等相關規則。

「文件季別」可以使用影片專案嗎?

會。開放原始碼組織可自行發布專案構想,以及選擇由技術文件撰寫者提交的專案提案。如果影片符合開放原始碼機構的要求,您可以提交該影片做為 Google 文件季度專案,前提是製作的是技術說明影片。請確保影片要求範圍明確,且製作優質影片需要時間和資源。

輔導機構是否需要使用技術文件撰寫專員製作的文件?

不需要。雖然我們希望此計畫產生的所有說明文件和程式碼都能找到理想的家,但我們並不需要機構使用技術撰寫者的文件或程式碼。

文件季別發生在哪裡?

《Google 文件》的季別完全在線上進行。參加這項計畫並不需要旅遊。

如何掌握文件季度的資訊?

請造訪 season-of-docs-announce 的公告郵寄清單,取得與文件季度相關的最新消息和公告。加入群組即可透過電子郵件接收最新資訊。

我可以透過什麼方式協助宣傳「文件季別」?

您可以張貼有關節目的推文、撰寫網誌文章、發布影片,或舉辦當地聚會或資訊講座。我們提供一些內容和資源範例,可讓您用來發布給社群 (機構、撰寫者群組和其他聯絡人)。

如何籌劃或舉辦整季文件資訊會議或聚會?

歡迎您隨時安排會談的時間。請參閱計畫規則並使用範例內容

我可以同時擔任導師和技術文件人員的「文件季別」嗎?

不會。我們希望能確保每個專案和技術撰寫者都獲得足夠的關注,並認為這可能會對相關人士造成不良體驗。請選擇參與活動時,您是更吸引人的導師或技術文件撰稿人,並規劃據此申請。

針對 2019 年的 Google 文件季度,你有什麼可以分享的統計資料?

可以,您可以前往這裡查看 2019 年計畫文件季度。

我可以取得整季文件 T 恤嗎?

當然!順利完成專案的技術文件撰稿人和導師將獲得整季 Google 文件 T 恤。

我的 T 恤何時會到?

我們預估你會在 2021 年初收到 T 恤。Google 已聘請廠商製作 T 恤,並處理世界各地運送產品的物流作業。Google 計畫管理員會透過電子郵件將專屬存取碼傳送給您,方便您選取 T 恤款式/尺寸。另外,在我們公布長期專案結果的公告後,請盡快輸入運送詳細資料。製作和運送 T 恤通常需要幾週的時間。

如有其他問題,該怎麼辦?

查看技術寫入者指南導師指南機構管理員指南

閱讀所有說明文件後,如果您還是找不到答案,請考慮與 Slack 文件社群的 Slack 社群或討論清單討論問題。請參閱討論管道相關資訊,以及如何與我們聯絡

技術文件撰寫者適用

技術文件撰寫人員何時可以申請文件整季?

技術文件寫入階段為 2020 年 6 月 9 日至 2020 年 7 月 9 日。請參閱計畫時程表技術文件撰寫者指南

如要參與第一季文件,我應該瞭解哪些文件工具和架構?

您需要使用的說明文件工具和架構,依您想合作的機構而定。《The Season of Docs》季的目標是打造開放原始碼專案,目的是協助技術撰寫人員進一步瞭解開放原始碼產品所用的工具和架構。因此,在開始進行文件季專案之前,通常不需要對特定說明文件平台有詳細的瞭解。

也就是說,大多數開放原始碼機構在製作說明文件時,都會使用某種版本的 Markdown 或其他標記語言。建議您找出所選機構使用的語言,並熟悉相關語法。Markdown 是不錯的起點,因為 GitHub README 檔案使用各種 Markdown 版本。請參閱 GitHub 指南

確認所選機構是否已在網站上代管說明文件,以及他們使用的平台是否也相符。該平台可能是靜態網站產生器,例如 JekyllSphinxHugo,或者機構可在閱讀說明文件GitHub 頁面中代管說明文件。找到平台機構使用後,請探索並試用相關語言與架構。這有助於您快速開始使用開放原始碼專案,並讓開發人員可以針對您選擇的開放原始碼專案提供合適的音效建議。

參與「Google 文件」季後,我應該使用哪些程式設計語言?

視說明文件專案的性質而定,您可能需要熟悉程式設計語言。在選擇及提議說明文件專案時,請記住這一點,並諮詢開放原始碼組織所需的熟悉程度。

我可以提交多項專案提案嗎?

可以,但每位技術文件撰寫專員只會接受一項專案提案。請參閱建立應用程式指南。

已經開始處理開放原始碼專案的技術文件可以繼續處理該專案的季節作業嗎?

可以,但您應該留意提案中與專案先前的關係。

小組中的提案可以配合一項專案提交提案嗎?

不行,一個專案只能由一人處理。

我可以在將提案提交至「文件季別」前,直接聯絡指導機構嗎?

可以,您可以先與有興趣合作的開放原始碼機構直接聯絡,然後再提交申請文件季度應用程式。開放原始碼導師可協助您修正專案構想。

參加計畫的資格規定為何?

  • 你必須年滿 18 歲才能註冊。
  • 在計畫期間,您必須有資格在所居住的國家/地區工作。
  • 您必須居住在美國境外的國家/地區。請參閱美國財政部的計畫規則制裁計畫與國家/地區資訊

Google 可以破除相關資格規定嗎?

否。如果您未符合資格要求,無論您的人才程度或興趣為何,我們都不會破例。特此例外並不適合應參加「文件季」的其他技術撰寫者。

我需要提供哪些表單?

申請獲準的參與者須提供適當的稅務表單

我是技術文件撰寫者的過往經驗或訓練嗎?

建議您在進行技術寫作或接受訓練時願意參加,但並非必要。提交專案提案時,您可以說明自己的體驗和/或以技術寫作訓練。您應能夠提供一些證據,證明您對技術說明文件或開放原始碼說明文件感興趣,包括您所撰寫的文件範例。「文件季別」計畫的目標,是與經驗豐富或從事培訓的技術寫作人員合作,讓每位成員都能互相學習。開放原始碼機構會尋找機構所需經驗程度的技術撰寫人員,以確保他們在文件專案季度中順利完成。

參加《文件季》後會獲得報酬嗎?

會。Google 會為成功完成計畫的技術撰寫者提供促銷優惠。您可以選擇取消訂閱提示。詳情請參閱技術寫入者承諾

即使機構未使用我的文件或程式碼,我還會收到費用嗎?

可以,前提是您的專案通過開放原始碼導師的最終評估。無論開放原始碼專案是否使用產生的說明文件或程式碼,都不會對技術撰寫人員認可的款項造成影響。

怎樣才算是優質的技術文件撰稿人?

最理想的提案是由技術文件撰寫者提供,他們會在提交文件季度應用程式「之前」,花時間與所選開放原始碼機構互動,討論構想。請參閱建立應用程式指南。

參與 Google 文件季節需要多少時間?

花費的時間取決於您與導師機構議定的專案性質。我們刻意設有時數的要求彈性,支援不同類型的專案和不同的工作風格。技術撰寫者平均每週會花費 20 到 30 小時。

提交專案提案之前,請先評估專案,並與開放原始碼機構討論時間預估時間。如果您在其他承諾使用時,您無法以協議的時間花費在「協議」清單中,則可選擇更長時間地完成專案,這樣您仍然會收到關於完成工作的秘訣和確認信。當您提交整季文件應用程式時,請指定長時間執行的專案選項。

我正在學習技術溝通,但目前還沒有任何工作經驗。我還能參加嗎?

會。提交專案提案時,請在有關過往工作經驗的專區中列出您所屬的大專院校或大學課程。

我是美國的 F1 簽證學會資格學生。如何取得參加授權?

詳情請洽詢貴校的國際學生事務辦公室。Google 無法提供您任何類型的 CPT 或 Opt 授權。

所有已接受的參與者都會收到接受確認電子郵件。我們不提供自訂信件。

「Google 文件的季別」會如何使用申請表中的資訊?

Google 計畫管理員會將應用程式的部分資訊傳送至所選開放原始碼機構的管理員,以便機構評估您的專案提案。

如果您的專案獲準加入計畫,「文件季別」就會在網站上發布專案詳細資料。

請參閱技術文件撰寫申請表指南中的資料使用方式說明。

我可以同時擔任文件季技術撰寫者和 Google Summer of Code 的學生嗎?

雖然目前未違反上述規則,但我們強烈建議選擇接受 Google Summer of Code 的學生申請 Google Summer of Code,針對文件季的程式設計人員時段。學生應將重心放在 Google Summer 的工作,而非應用文件季度。

開放原始碼導師和機構管理員專用

我想進一步瞭解如何參與文件季的導師。我可以在哪裡找到更多相關資訊?

如要進一步瞭解如何成為文件導師的季節,請參閱導師指南計畫規則

輔導機構有哪些資格規定?

如要成為指導機構,您必須是執行有效免費/開放原始碼軟體專案的群組,例如 BRL-CAD。專案不一定要是具有法律效力的實體。顧問機構必須依據開放原始碼計畫核准授權製作及發布軟體,且至少有兩位協作者擔任整個文件季度的機構管理員和/或導師,才能參與這項計畫。

另請參閱「計畫規則」和美國財政部制裁計畫與國家/地區資訊中所述的資格規定。

「機構」是否等同於開放原始碼專案?

某機構可能有一或多個開放原始碼專案,有些機構 (例如基礎) 可能有多個子機構,而每個子機構都有一或多個開放原始碼專案。如果貴機構有獨立的子機構,請在申請表中清楚說明相關資訊。例如,程式設計語言「Foo」可以涵蓋整個語言的說明文件,以及使用該語言的任何外掛程式、程式庫或模組。

機構是否可針對參加「Google 文件季」的比賽支付費用?

而記錄良好的機構在計畫結束時,會獲得每位認可的技術撰寫者的小費。無論技術寫入者的專案成功與否,這都是如此。機構可依需求自由運用這些資金。

Google 計畫管理員如何為技術編寫專案分配運算單元?

2020 年完整的文件季別,總計最多只能有 50 個技術撰寫專案。

根據準則,我們預期每個機構最多接受 2 項專案,因此不會有太多接受的專案。不過,如果免費選擇流程並未填滿所有時段,Google 計畫管理員可能會將更多運算單元分配給部分機構。

因此,傳送所選的技術寫入專案時,您最多可以選取 2 個專案。請務必按照優先順序列出您的選項,並以優先順序排在清單頂端。

與技術文件撰寫者溝通時,您必須清楚說明,Google 計畫管理員在計畫網站上發布已接受的專案清單後,才會接受該專案。

機構申請可以在提交期限前接受審查嗎?

很抱歉,我們無法針對機構申請結果提供意見回饋。

機構應該如何限定專案構想的範圍?

許多專案會在發展期間變更範圍。導師必須瞭解專案是否有任何變動,並盡量減少範圍,並視情況縮小範圍。研擬專案構想時,請試著找出能為機構創造價值的小型專案 (如果時間允許,也可以擴大專案規模)。越小越好。當您評估技術撰寫者的提案時,建議您優先採用較小型的專案,而非較不明確的大型專案。如果你的專案需要大量的專業領域知識,請試著納入沒有該背景的其他人可以處理的專案。

技術文件稽核專案是否為合理的文件季度專案?

說明文件稽核是很實用的文件季度專案。請留意已經擁有的文件數量,如果有很多文件,可能會需要縮減範圍 (例如只稽核教學課程內容)。如果貴機構幾乎沒有或完全沒有說明文件,不妨在專案中納入優先度最高且缺少的說明文件。

機構和技術撰寫專員是否有可用的說明文件範本?

Good Docs Project 致力於為開放原始碼建立一些最小可行的文件範本。

可以同時擔任機構管理員和導師並參與「文件季別」嗎?

會。機構管理員也可以擔任導師。您不需要另外填寫顧問表單。填寫機構申請表或替代管理員表單時,您應使用表單中的選項表示您同時擔任導師。

我可以同時參與《文件季》和 Google Summer of Code 的機構管理員或導師嗎?

會。《文件季》和 Google Summer of Code 都是獨立的程式。如果可以參與這兩種程式的頻寬也沒有問題。

我可以同時擔任機構管理員或導師,同時參與「文件」和「Google 程式碼研究室」的訓練嗎?

會。文件季別和 Google 程式碼是獨立的程式。如果可以參與這兩種程式的頻寬也沒有問題。

封存資料

如何移除「文件季別」封存檔中的資訊?

如要移除您的資訊,請與我們聯絡