常見問題 (FAQ)

目前階段:
專案定案。請參閱時間表

一般

Google Season of Docs 是招募計畫嗎?

否。如有意加入 Google 團隊,請前往 Google 工作網站

我們的機構想參加 Google 文件季,但不知道該從何著手

歡迎參考完整的專案構想清單!您也可以與技術寫作社群聯絡 (請嘗試在 Write the Docs Slack 或社群媒體管道中的 #season-of-docs 頻道尋求協助或提出建議)。

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

不妨參考下列建議:

  • 在技術撰寫者和開放原始碼組織決定的平台上建立說明文件網站,並在網站上發布初始的基本文件。平台示例包括:

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

  • 針對產品或功能撰寫概念總覽或介紹。團隊通常會自下而上建立技術文件,結果是內容雖然很詳細,但很難讓人瞭解產品的整體情況。技術撰寫人員可以修正這個問題。

  • 針對知名用途建立教學課程。

  • 針對特定工作建立一組專注的操作說明指南。

  • 建立貢獻者指南,其中包含有關如何開始擔任開放原始碼專案貢獻者的相關基本資訊,以及任何關於授權協議、提取要求和審查程序、建構專案等的規則。

影片是否可用於 Google 季度文件專案?

可以。請確保影片需求範圍明確,並注意製作高品質影片需要大量時間和資源。

說明文件稽核是否適合 Google 說明文件季?

說明文件稽核是 Google 說明文件季節的絕佳專案。請留意您已擁有多少文件;如果數量很多,您可能需要縮小範圍 (例如只審查教學課程內容)。如果您沒有或只有少量說明文件,建議您在專案中加入建立最高優先順序缺少說明文件的作業。

是否有可供機構和技術撰稿人使用的說明範本?

Google 說明文件季節提供一個 GitHub 存放區,其中包含可用來執行說明文件稽核作業的範本和檢查清單。我們會在其他範本建立後加入。

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

機構是否必須使用技術作家製作的文件?

否。有時專案可能無法如預期運作,或需求有所變更。我們不會要求機構使用產生的說明文件或其他材料,但我們希望最終評估和個案研究中會討論為何不使用說明文件,以及為何不使用說明文件或其他材料。

Google 文件季節活動會在哪裡舉辦?

Google 文件季節活動完全在線上進行。您不必在計畫期間出差。

如何隨時掌握 Google 文件季的最新動態?

如要瞭解與 Google 季度短片季相關的最新消息和公告,請前往 season-of-docs-announce 查看公告電子報。加入這個網路論壇,接收電子郵件最新消息。

我可以將 Google 季節性文件時間表新增至日曆嗎?

使用 http://goo.gle/2NeZVew 訂閱 Google 季節性文件日曆。

我該如何宣傳 Google 文件季節?

你可以發推文宣傳這項計畫、撰寫網誌文章、發布影片,或是在當地舉辦聚會或資訊說明會。我們提供一些範例內容和資源,供您發送給社群 (機構、作家群組和其他聯絡人)。

如何安排或主持 Google 文件季節資訊座談或聚會?

歡迎您在方便的時間和地點安排聚會!詳閱計畫規則,並使用範例內容

你能否提供 2019 年和 2020 年計畫的統計資料?

是的,您可以在 Google 開放原始碼網誌上查看 2019 年 Google 文件季的結果 (20192020)。

我會收到 Google 文件季節 T 恤嗎?

否,由於國際運送限制,Google 季節性文件活動無法再向成功完成 Google 季節性文件活動專案的參與者提供 T 恤。

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

請參閱機構管理員指南技術撰稿人指南

如果您閱讀完所有說明文件後仍未獲得解答,建議您在討論清單中與 Google 文件季節社群討論您的問題。請參閱討論管道相關資訊,以及聯絡我們的方式。

如何成為 Google 季度文件計畫的導師?

Google 季度文件計畫並沒有正式的導師角色。機構應在機構申請中,說明如何安排技術作家加入並提供支援,以及如何審查及核准他們提供的文檔內容。如果你有意在 Google 文件季中擔任技術作家的指導老師,請向貴機構的管理員提出志願。

Google 文件季和 Google 程式碼夏令營有何不同?

否。Google 季節性文件計畫適用於具備一定技術寫作經驗的人士,並非像 Google 夏季程式碼計畫那樣,提供指導計畫。

技術文件撰寫人員

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

Google 文件季並沒有正式的技術作家申請表。如要以技術作家身分參與 Google 季節性文件計畫,請直接與開放原始碼組織聯絡,並按照該組織 Google 季節性文件計畫網頁上的指示操作。您也可以將自己加入 Google 季度技術文件撰寫人員名冊,表達您的興趣。詳情請參閱技術作家指南

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

您要使用的文件工具和架構取決於您想與哪個機構合作。Google 文件季的目標之一,就是讓開放原始碼專案協助技術作家進一步瞭解開放原始碼產品說明文件的工具和架構。因此,在開始 Google 說明季專案之前,您不一定要具備特定說明平台的詳細知識。

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

找出所選機構是否已在網站上代管文件,如果是的話,請查看他們使用的平台。平台可能是靜態網站產生器,例如 JekyllSphinxHugo,或者組織可能會在 Read the DocsGitHub Pages 上託管文件。瞭解客戶使用的平台後,請探索並嘗試相關語言和架構。這有助於您快速開始使用開放原始碼專案,並為所選開放原始碼專案提供可靠的建議。

如要參與 Google 文件季節專案,我應該學習哪些程式設計語言?

視說明文件專案的性質而定,您可能需要熟悉程式設計語言。選擇及提案說明文件專案時,請留意這一點,並向開放原始碼機構洽詢所需的熟悉程度。

技術作家是否可以繼續在 Google 文件季中處理開放原始碼專案?

可以,但機構應在提案中註明技術作家與專案的先前或持續關係。

參與資格規定為何?

我是否需要具備技術文件撰寫經驗或接受相關訓練?

具備技術寫作經驗或接受過相關訓練尤佳,但並非必要條件。向機構提交意願書時,您可以說明自己的經驗或曾接受的任何技術寫作訓練。您應該能夠提供一些證據,證明您對技術文件或開放原始碼文件感興趣,包括您撰寫的文件範例。開放原始碼組織會尋找符合組織所需經驗水準的技術作家,確保順利完成 Google 說明文件季專案。

參與 Google 文件季節是否會獲得報酬?

可以。Google 會向獲選的機構提供補助金,讓他們聘用技術作家。

優秀的技術作家興趣聲明應包含哪些內容?

最佳的興趣聲明來自技術作家,他們會花時間與所選開放原始碼組織互動,並在提交聲明前討論自己的想法。請參閱指南,瞭解如何建立興趣陳述式

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

專案規模各異,但在計畫期間,每週的投入時間約為 5 到 30 小時。不過,您花費的時間長短取決於您與機構達成的專案性質。在提交前,您應評估專案,並與開放原始碼機構討論預估時間。

我可以以個人身分提交機構申請,為開放原始碼專案建立文件嗎?我想建立一系列的網誌文章、影片或其他素材,說明如何使用開放原始碼專案或工具,但我並非該專案的參與者或貢獻者。

否,您必須能夠代表開放原始碼專案收取款項,才能提交提案。如果您有意參與專案,請與專案團隊聯絡,共同提出應用程式提案。

我是學生,可以參加 Google 季節性文件計畫嗎?Google 文件季會教我如何成為技術文件撰稿人嗎?

學生可以與獲准的機構合作,但 Google 文件季並非旨在教授技術寫作技能。參與的技術寫作者應具備專業的技術寫作技能,或具備同等的相關經驗。有意參加的學生在申請時,請務必強調自己具備相關的寫作和編輯經驗。

我可以同時以技術作家的身分參與 Google 季節性文件計畫,並以學生身分參與 Google 夏季程式設計計畫嗎?

我們不建議新貢獻者或已獲 Google 夏季程式設計競賽 (Google Summer of Code) 錄取的學生申請成為 Google 文件季節技術作家。

Google 文件季節並非初學者專屬,而是專為具備扎實技術寫作技能和經驗的人士而設。Google 文件季節的技術作家不會接受指導,而是需要自行組織並激勵自己,在機構管理員和其他社群成員的指導下,盡可能自行規劃如何處理機構專案。

技術作家如有其他問題或疑慮,該如何與 Google 季節性文件 Google 計畫管理員聯絡?

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

技術寫作公司或顧問公司可以參加 Google 文件季嗎?

是的,機構可以聘請公司執行提案中列出的作業。

如何在履歷中提及 Google 季節性文件?

請按照其他自由接案的方式列出這項經驗:「在 Google 季節性文件計畫中,擔任 [專案名稱] 的技術作家。」

你是否會為 Google 文件季節的參與者提供結業證書?

Google 文件季節無法向技術作家傳送證書或參與專案的確認訊息。

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

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

如要以機構身分參與計畫,您必須是執行積極免費或開放原始碼軟體專案的群組,例如 BRL-CAD。專案不必是合法註冊實體。機構必須開放原始碼計畫核准的授權下製作及發布軟體,並至少有兩位貢獻者擔任 Google 文件季節計畫的機構管理員,才能參與該計畫。

請參閱計畫規則和美國財政部提供的制裁計畫和國家資訊中所述的資格規定。

「組織」是否等同於開放原始碼專案?

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

一個機構是否可以提交多個提案申請?

不可以。每個機構只能提交一份申請。如果貴機構有子機構 (例如,貴機構是擁有多個獨立開源專案的基金會),則每個專案都應提交自己的申請表,即使補助金將由總機構處理也一樣。

一組開放原始碼專案是否可以共同提交提案,以便共同進行單一說明文件專案?

一個機構應提交提案申請,並負責協調其他參與專案的工作和支援。(舉例來說,如果一組小型開源專案都是大型專案的插件,而該專案想要共同編寫插件的操作說明,就應選擇一個機構來領導專案)。

我的機構如何收到款項?

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

機構參與 Google 季節性文件計畫會獲得任何金錢嗎?

機構可以將行政管理、指導或審查作品的費用納入專案預算。

Google 會支付付款處理費用嗎?

Google 不會支付付款處理費用,因為這類費用通常會因付款方式而異。不過,Google 會負擔 Open Collective 平台費用,如果您決定使用 Open Collective 做為財務主機,該費用也會由 Google 負擔。詳情請參閱接收補助金指南

我的機構應如何編列技術作家的預算?

建議您參考 Write the Docs 薪資調查,並計算時薪。您也可以加入 Write The Docs Slack,並在 #season-of-docs 頻道中詢問有意參與的技術作家是否願意投標。

我的機構可以使用 Google 季節性文件計畫補助金支付現有作者的費用嗎?

可以。不過,專案提案必須是針對新工作 (包括維護工作、修訂或現有文件升級)。您不得申請補助金,用於支付已完成的工作。

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

您可以選擇讓學生技術寫作人員處理專案。如果您選擇與學生合作,強烈建議您只讓符合以下條件的學生參與:

  • 年滿 18 歲
  • 就讀技術寫作或技術通訊課程
  • 透過課程或課程計畫,可獲得技術寫作指導

我的機構是否可以與多位技術作家合作?

貴機構可以選取並支付多位技術作家,但與貴機構合作的所有技術作家都必須參與您提出的專案。與多位技術作家合作會使專案變得更加複雜,並需要更多志工和管理時間。

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

是的,貴機構可以聘請技術寫作公司來處理專案。請確認你聘用的公司可以透過 Open Collective 收款。

我們的技術作家在計畫結束前就離開了。我們的機構是否仍有資格領取剩餘款項?

強烈建議專案嘗試尋找新的技術作家,在計畫結束前完成專案。不過,剩餘款項的撥款並非以專案完成為準,而是以個案研究和最終評估完成為準。

如果無法完成專案,請在個案研究中說明原因。舉例來說,您可能發現說明文件工具相當複雜,因此無法順利引進技術作家;或者,您的專案涉及測試和更新教學課程,且需要豐富的程式設計經驗。根據您的經驗,您會向其他專案推薦哪些做法?請在個案研究中加入這項資訊。

機構申請是否可以在提交截止日期前審查?

很抱歉,Google 文件季節無法針對組織申請提供意見回饋。

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

在構思專案時,請盡量找出最小規模的專案,為組織帶來價值 (但如果時間允許,可以擴大規模)。越小越好。建立專案提案時,建議您選擇較小且較詳細的專案,而非較大且較不具體的專案。如果專案需要大量領域專業知識,請盡量納入可由沒有該領域背景的人處理的專案。

我可以以機構管理員身分參與 Google 季節性文件計畫,並以指導老師身分參與 Google 程式設計夏令營嗎?

可以。Google 文件季和 Google 程式設計夏令營是兩項不同的計畫。如果你有能力同時參與這兩項計畫,那麼沒問題。

我們的機構曾參加過先前的 Google 季節性文件計畫。我們的機構可以再次申請嗎?

可以,曾參加過 Google 季節性文件計畫的機構組織可以再次申請。

封存的資料

如何從 Google 季節性文件檔案中移除我的資訊?

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