常見問題 (FAQ)

目前階段:
結果公布時程

一般

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

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

目前的計畫與 2019 年和 2020 文件季度有何不同?

目前的文件季度與前幾年有重大異動,包括:

  • 技術文件撰寫者不會再透過 Google 申請來與機構進行比對
  • 在申請過程中提交專案提案 包括預算和建議指標
  • 獲選的機構會獲得補助金,並用來支付技術撰寫者費用
  • 機構提交最終評量和個案研究

為什麼 Google 文件季度做了這些調整?

Google 的使命是彙整全球資訊,供大眾使用,使人人受惠。我們調整了文件季度,並強調從開放原始碼中取得有效的說明文件做法,希望能長期發揮更大的影響力。

我們的機構好像想參加《Google 文件季》系列活動,但還不知道該從何處著手!

詳情請參閱專案構想的完整清單! 您也可以與技術文件社群聯絡 (使用「編寫文件 Slack」中的 #season-of-docs 管道,或您的社群媒體管道尋求協助或建議)。

機構可以提出哪些類型的專案?

不妨參考下列建議:

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

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

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

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

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

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

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

會。請確保影片要求範圍明確,並注意製作優質影片需要花費大量時間和資源。

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

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

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

各季文件都有一個 GitHub 存放區,其中含有範本和檢查清單,用於執行說明文件稽核。我們希望在建立其他範本時再加入。

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

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

否,有時專案無法如預期般出現,或是要求有變動。我們不要求機構使用所製作的說明文件或其他素材,但我們的預期最終評估和個案研究會包含討論文件未使用原因,以及專案如何決定不使用說明文件或其他素材。

文件季別發生在哪裡?

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

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

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

我可以在日曆中新增文件季別的時間軸嗎?

可以,您可以透過這個連結新增該憑證。

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

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

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

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

針對 2019 年和 2020 年的 Google 文件季度,你是否有可以分享的統計資料?

可以,您可以前往這裡查看 2019 年計畫文件季度。如要查看 2020 年計畫成果,請按這裡

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

不可以,由於國際運送限制,我們無法為成功完成 Google 文件季別的參與者提供 T 恤。

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

請參閱機構管理員指南技術寫入者指南

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

如何擔任文件季的導師?

文件季別沒有正式的導師角色。機構應指定技術撰寫者的參與和支援方式,以及他們如何在機構申請審核及核准其說明文件貢獻。如果您對「文件季別」的指導技術撰寫者感興趣,建議您與機構組織管理員共同自願。

那季文件是像 Google Summer of Code 的嗎?

不可以。文件季別適用於具有一定技術寫作經驗的使用者, 而非像 Google Summer of Code 這樣的指導計畫。

技術文件撰寫者適用

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

《文件季》沒有正式的技術撰寫應用程式。如要以技術文件撰寫者的身分加入「文件季別」,請按照「說明文件季別」計畫頁面中的操作說明,直接與開放原始碼機構聯絡。您也可以把自己加入 Document of Docs Technical Writer Directory (文件技術寫入人員目錄) 中,表達您的意願。詳情請參閱技術寫入者指南

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

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

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

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

如要參與 Google 文件季度專案,我應該知道哪些程式設計語言?

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

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

可以,但機構應留意技術撰寫者先前或提案中與專案之間的關聯。

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

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

建議您在進行技術寫作或接受訓練時願意參加,但並非必要。向機構提交興趣陳述時,您可以描述自己的體驗和/或以技術寫作訓練。您應能夠提供一些證據,證明您對技術說明文件或開放原始碼說明文件感興趣,包括已編寫的文件範例。開放原始碼機構應尋找符合機構所需經驗的技術撰寫人員,以確保他們順利完成文件專案季度。

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

會。Google 將提供補助金給已獲認可的機構,以便聘請技術文件撰寫專員。

如何編寫良好的技術撰寫者利益聲明?

最值得注意的描述是來自技術撰寫者,他們會在提交聲明「之前」,花時間與所選開放原始碼機構互動,討論他們的想法。請參閱建立興趣聲明表單指南。

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

專案規模各有不同,但計畫期間每週的承諾使用時數為 5 至 30 小時。不過,花費的時間取決於您與機構達成協議的專案性質。修訂之前,您應先評估專案,並與開放原始碼機構討論時間預估。

我可以提交機構申請,以個人身分製作開放原始碼專案的文件嗎?我想建立一系列的網誌文章、影片或其他資料,瞭解如何使用開放原始碼專案或工具,但我不屬於專案的成員,也不是內容提供者。

不可以,只有在您能夠代表開放原始碼專案收款時,才能提交提案。建議您與專案聯絡,並合作討論申請提案。

我是學生,是否符合閱讀《文件季》的參與資格?Google 文件季度會教我成為技術寫作嗎?

學生符合與認可機構合作的資格,但 Google 文件的季別並非用來教導技術寫作技能。我們希望參與技術撰寫者俱備專業技術寫作技能或同等的相關經驗。如果學生想要參與計畫,就應該先凸顯他們相關寫作和編輯經驗,與感興趣的機構和專案聯絡。

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

雖然目前未違反上述規則,但我們強烈建議學生參加 Google Summer of Code,並不適用於文件的當季技術撰寫者。學生應將重心放在 Google Summer 編寫的程式碼,而非應用在文件季度上。

此外,「各季文件」不適合初學者,適合已具備卓越技術寫作技能和經驗的人使用。《文件季》的技術撰寫者並未接受指導,他們需要自行規劃,並激勵自己規劃處理機構專案的計畫,並盡可能減少機構管理員和其他社群成員的指引。

身為技術文件撰寫者,如果我有其他問題或疑慮,該如何與文件季度 Google 計畫管理員聯絡?

如要與文件季別的 Google 計畫管理員聯絡,請傳送電子郵件至 season-of-docs@google.com

技術文件公司或顧問可以參與「文件季別」嗎?

可以,機構可以聘請公司來執行提案中所述的工作。

如何在履歷中參考 Google 文件季別?

請比照其他自由接案作業的方式列出產品,例如「在 Google 文件季度期間,擔任 [專案名稱] 的技術文件撰稿者。」

您是否提供參加「文件季別」的結業證書?

不過,我們無法向技術文件撰寫者提供專案參與資格或確認證明。

適用於開放原始碼機構管理員

開放原始碼機構的資格規定為何?

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

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

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

某機構可能有一或多個開放原始碼專案,有些機構 (例如基礎) 可能有多個子機構,而每個子機構都有一或多個開放原始碼專案。如果您的機構具有獨立的子機構,請分別為每個子機構提交申請和提案。

機構可以提交多個提案申請嗎?

不可以。每個機構只能提交一份申請書。如果您的機構有子機構 (例如您的機構是許多個別開放原始碼專案的基礎),則每個專案都應提交自己的申請,即使補助資金會由綜合機構處理也一樣。

同一個文件專案可以由一組開放原始碼專案提交提案嗎?

一個機構應提交提案申請,並負責協調其他參與計畫的專案與支援。(舉例來說,假設有一組小型開放原始碼專案,這些專案全都是大型專案的外掛程式,而對於建立外掛程式的共同使用指南,則應選擇一個機構主導專案)。

我的機構如何收到款項?

貴機構必須擁有 Open Collective 帳戶,才能收到款項。

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

機構可以在專案預算中納入管理、指導或審查作業的資金。

Google 是否負擔付款處理費?

付款手續費不在 Google 的涵蓋範圍內,因為費用會因付款方式而異。不過,Google 確實會支付 Open Collective 平台費用,如果您決定使用 Open Collective 做為財務主機,Google 也會承擔相關費用。詳情請參閱接收補助指南

我的機構該如何分配技術作家的成本?

建議您參閱撰寫文件薪酬問卷調查,並瞭解每小時費率。您也可以加入 Write The Docs Slack 社群,透過 #season-of-docs 頻道向有興趣的技術撰寫人員出價。

我的機構可以支付文件季度授權費用給目前協作者嗎?

會。不過,專案提案必須適用於新工作 (包括維護、修訂版本或現有說明文件升級)。請勿申請用於支付已完成工作費用的補助金。

我的機構可以與學生技術寫作人員合作嗎?

您可以選擇請學生技術撰寫專員完成專案。如果選擇與學生合作,強烈建議您只與具有下列條件的學生合作:

  • 年滿 18 歲
  • 已註冊技術文書或技術傳播計畫或課程
  • 透過這項計畫或課程,展現豐富的技術寫作輔導能力

我的機構可以與多位技術文件撰寫專員合作嗎?

貴機構可能會選擇並支付多位技術寫入者,但所有與貴機構合作的技術撰寫者都必須執行您提出的專案。與多位技術文件撰寫專員合作會增加專案複雜度,且需要更多志工和管理時間。

我的機構可以聘請技術寫作公司來處理專案嗎?

是的,貴機構可能會聘請技術寫作公司來處理專案。請確保你聘僱的公司可透過 Open Collective 收取款項。

我們的技術文件撰寫專員在計畫結束前退出。我們是否仍可收到剩餘的資金?

我們強烈建議您在計畫結束前,嘗試尋找新的技術文件撰稿人完成專案。不過,剩餘資金並非依據專案完成度來發放,而是取決於個案研究和最終評估的結果。

如果專案無法完成,我們預期個案研究會探討原因。例如,您可能發現說明文件工具十分複雜,也證明瞭新手技術撰寫人員的障礙,或者您的專案涉及測試及更新教學課程,且需要豐富的程式設計經驗。您可根據自己的經驗,向其他專案推薦什麼?在個案研究中附上這項資訊。

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

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

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

發展專案構想時,請嘗試找出最小型的專案,能為機構創造價值 (但如果時間允許,也可以擴大專案範圍)。越小越好建立專案提案時,建議您根據較不指定的大型專案,選擇較小型且詳盡的專案。如果您的專案需要大量的領域專業知識,請試著納入能由沒有該背景的人員處理的專案。

我可以擔任文件季別的機構管理員,以及 Google Summer of Code 的導師嗎?

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

我們的機構參加過前一季的 Google 文件計畫。我是否符合再次申請的資格?

是,參與上一季文件計畫的機構可以再次申請。

封存資料

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

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