當前階段:
2021 賽季文件計畫已於 2021 年 12 月 14 日結束,請參閱時間表。
一般
「Google 文件」季是招募計劃嗎?
不需要。如果你有意為 Google 工作,請造訪 Google 工作機會網站。
2021 年 Google 文件季度有哪些異動?
文件 2021 的季別與前幾年有重大異動,包括:
- 技術撰稿人不再透過 Google 應徵,因此無法比對到機構
- 機構會在申請過程中提交專案提案 包括預算和提議的指標
- 已接受的組織會獲得補助,用來支付技術撰寫人員
- 組織提交最終評估和個案研究
為什麼文件季會進行這些變更?
Google 的使命是彙整全球資訊,供大眾使用,使人人受惠,在我們重新聚焦於文件季度上,著重在學習有效的開放原始碼說明文件做法後,希望能長期發揮更大的影響力。
我們的機構想參與 2021 年文件季,但不知該從何著手!
歡迎查看完整的專案想法清單!您也可以聯絡技術寫作社群 (請嘗試使用「Write the Document Slack」(撰寫文件 Slack) 中的 #season-of-docs 頻道,或在社交媒體管道上尋求協助或提案。
機構可以提出哪些類型的專案?
不妨參考下列建議:
在平台上建立說明文件網站,供技術撰寫人員及開放原始碼組織決定,然後在網站上發布一組基本文件。例如:
重構開放原始碼專案的現有說明文件,以提供改善使用者體驗或更容易存取的資訊架構。
撰寫產品或功能的概念總覽或簡介。一般而言,團隊通常會由下而上建立技術說明文件,結果有很多細節,但很難瞭解產品整體。技術撰寫人員能修正這個問題。
建立有關重要用途的教學課程。
針對特定工作建立一組聚焦式使用指南。
建立貢獻者指南,內容包括如何開始成為開放原始碼專案貢獻者的基本資訊、有關授權協議、提取要求與審查程序、建構專案等的所有規則。
「Google 文件」季別是個可以拍攝的影片嗎?
需要。確保影片要求的範圍適當,並請注意製作高畫質影片需要耗費大量時間和資源。
稽核文件是對「文件」季別來說是否合理的專案嗎?
文件稽核作業非常適合用於「文件」季。請留意現有的文件數量;如果您的文件數量很多,可能需要縮減範圍 (例如只稽核教學課程內容)。如果您只有少部分或沒有任何說明文件,可以在專案中加入優先順序最高的缺少的說明文件。
有沒有文件範本可供組織和技術撰稿人使用?
文件季度有 GitHub 存放區,內含用於執行說明文件稽核的範本和檢查清單。我們希望在建立其他範本時加入。
The Good Document Project 目前正致力為開放原始碼建立一些最小可行的說明文件範本。
機構是否需要使用技術撰稿人製作的文件?
否。有時候專案無法如預期終止,或者要求發生變化。 我們不會要求機構使用產生的文件或其他素材,但我們預計最終評估和個案研究會包括討論為何不該使用該說明文件,以及這項專案如何決定該決定不使用文件或其他資料。
文件的季別出現在哪裡?
文件季是完全在線上進行。參加這項計畫不需要旅行。
如何掌握文件季度的最新資訊?
請前往 season-of-docs-announce 查看公告郵寄清單,取得與文件季度相關的最新消息和公告。加入群組即可透過電子郵件接收最新消息。
我可以在日曆中加入文件的季別時間軸嗎?
可以。您可以透過這個連結新增該網域。
如何協助宣傳「文件」季內容?
您可以發布有關這項計畫的推文、撰寫網誌文章、發布影片,或舉辦聚會或舉辦資訊活動。我們提供一些範例內容和資源,可用於向社群 (機構、撰寫者群組和其他聯絡人) 發布內容。
如何規劃或舉辦整季的「Google 文件」資訊講座或聚會?
您隨時可以視需要安排時間進行聚會!請參閱計畫規則並參考範例內容。
對於 2019 和 2020 季度文件,你是否有任何統計資料可以分享?
可以。您可以在這裡查看 2019 年計畫的季度文件結果。如要查看 2020 年計畫的結果,請按這裡。
這樣可以取得整季文件 T 恤嗎?
否,由於國際運送限制,我們無法再為成功完成「文件」季別專案的參與者提供 T 恤。
如有其他問題,該怎麼辦?
閱讀所有說明文件後,如果您還是無法找到答案,可考慮與「文件季別」社群討論您的問題。請參閱討論管道的相關資訊,以及如何與我們聯絡。
如何擔任 Google 文件季度的導師?
《2021 賽季》沒有正式的導師角色。機構應指定技術寫入者的加入和支援方式,以及他們在機構申請過程中如何審查及核准他們的文件貢獻。如果您有興趣在「Google 文件」季中指導技術撰稿人,建議您與機構管理員合作。
整季文件是像 Google Summer of Code 一樣嗎?
否。「文件季度」適用對象為具備技術寫作經驗的人,並非設計為指導計畫,例如 Google Summer of Code。
技術文件撰寫人員
技術撰稿人何時可以申請文件季文件?
在 2021 賽季中,我們沒有正式的技術寫作應用程式。如要以技術文件撰寫者的身分參與 2021 年整季文件,請按照相關「文件季別」計畫頁面中的操作說明,直接與開放原始碼機構聯絡。您也可以在「Season of 文件 技術寫入者目錄」中加入自己,表達您的參與意願。詳情請參閱技術撰寫人員指南。
我應該知道哪些文件工具和架構,才能參與「Google 文件」季別?
您使用的說明文件工具和架構視您想合作的機構而定。Google 文件季度的部分目標之一,是協助技術撰寫人員進一步瞭解可用於記錄開放原始碼產品的工具和架構。因此,您通常不需要先具備特定說明文件平台的相關知識,才能開始使用「文件季文件」專案。
也就是說,大部分的開放原始碼機構都會在說明文件中使用 Markdown 或其他標記語言。建議您找出所選機構使用的語言,熟悉語法。Markdown 是不錯的起點,因為 GitHub README 檔案採用 Markdown 的口味。請參閱 GitHub 指南:Markdown。
確認您選擇的機構是否已將說明文件託管在網站上,以及該機構使用的平台為何。該平台可能是靜態網站產生器 (例如 Jekyll、Sphinx 或 Hugo),也可能是機構在閱讀說明文件或 GitHub 頁面上代管文件。找到機構使用的平台後,請探索相關語言和架構,並進行實驗。如此可幫助您快速上手開放原始碼專案,也可以集中一處為您選擇的開放原始碼專案提供音效建議。
我應該瞭解哪些程式設計語言,才能參與 Google 文件的季度專案?
視說明文件專案的性質而定,您可能需要熟悉程式設計語言。當您選擇及建議說明文件專案時,請務必留意這一點,並向開放原始碼組織諮詢所需的熟悉程度。
已經開始執行開放原始碼專案的技術撰寫人員是否能繼續在 Google 文件中著手處理這類專案?
是的,但機構應記下技術撰寫人員先前或目前與提案中專案的關係。
參加計劃有哪些資格規定?
- 您必須居住在目前未受美國禁制的國家/地區。請參閱計畫規則和美國財政部的制裁計畫和國家/地區資訊。
我是否需要具備相關經驗或培訓,擔任技術撰稿人?
建議您事先完成技術寫作經驗或訓練,但不強制要求。 向機構提交興趣聲明時,您可以描述自己的經驗和/或技術書面訓練。您應能提供部分證據,以證明您對技術說明文件或開放原始碼說明文件感興趣,包括您編寫的文件範例。開放原始碼機構會尋找具備機構所需經驗程度的技術撰稿人,確保可以順利完成「Google 文件」專案的季度。
參加「文件季」計畫還能獲得報酬嗎?
需要。Google 將提供授權給獲準的機構,以便使用技術撰稿人。
怎樣才算是優秀的技術撰稿人?
最好的表達方式是來自技術撰稿人,他們花時間在提交陳述「之前」,花時間與所選的開放原始碼機構互動並討論構想。請參閱建立感興趣陳述式指南。
參與「文件」季需要多少時間?
專案規模各不相同,但可在計畫期間每週 5 至 30 小時。不過,您花費的時間取決於您與機構同意的專案性質。在提交之前,您應先評估專案,並與開放原始碼組織討論預估的時間。
我可以提交機構申請,以個人身分建立開放原始碼專案的說明文件嗎?我想撰寫一系列網誌文章、影片或其他素材,學習如何使用開放原始碼專案或工具,但我不是專案成員,也沒有提供協作者。
否,除非您能夠代表開放原始碼專案收款,否則請勿提交提案。我們建議您與專案聯絡,共同參與應用程式提案。
我是學生,可以參加 2021 年整季文件嗎?Google 文件的季節會教我成為技術撰稿人嗎?
學生有資格與獲得認可的機構合作,但「文件」季度的用意並非教導學生專業撰寫能力。我們期望參與的技術寫作人員具備專業的專業技術撰寫能力,或具備同等的相關經驗。想要參與的學生在聯繫感興趣的機構和專案時,請務必強調他們相關的寫作與編輯體驗。
我可以同時參與「文件季」的技術文件撰寫人員和 Google Summer of Code 的學生嗎?
雖然這目前未違反規定,但我們強烈建議接受 Google Summer of Code 的學生申請,並不適用於 Google 文件技術編輯季。學生應該專心處理 Google Summer of Code 的作業,而不是應用於申請季別文件。
此外,「文件季度」並非適合初學者,適用對象為熟悉技術寫作技巧和經驗的人員。文件季度的技術撰寫人員並未給予指導,而是需要自行規劃和積極規劃,在對機構專案進行最低限度的規劃時,在機構管理員和其他社群成員提供最少指導的情況下。
身為技術撰稿人,如果有其他問題或疑慮,要如何與 Google 文件季別的管理員聯絡?
如要與 Google 文件季度計畫管理員聯絡,請傳送電子郵件至 season-of-docs@google.com。
技術寫作公司或顧問可以參與整季文件嗎?
是的,機構可以僱用公司完成提案中列出的工作。
如何在履歷中參照季別文件?
比照其他自由接案內容的方式列出,例如「在文件季度計畫中擔任 [專案名稱] 的技術撰稿人」。
Google 是否提供參與「文件季」計畫的結業證書?
我們無法將參與專案活動的證明或確認函傳送給技術撰稿人。
適用於開放原始碼的機構管理員
開放原始碼組織必須符合哪些資格規定?
如要以機構身分加入,您必須是執行有效的免費/開放原始碼軟體專案 (例如 BRL-CAD) 的群組。專案不一定要是合法的公司實體。申請機構必須已經依據開放原始碼計畫核准的授權製作及發布軟體,且至少有兩個協作者擔任整季文件計畫的機構管理員,才能參與這項計畫。
另請參閱計畫規則和美國財政部的制裁計畫和國家/地區資訊中所述的資格規定。
「機構」是否等同於開放原始碼專案?
機構可能會有一或多項開放原始碼專案。某些機構 (例如基金會) 可能有多個子機構,而每個子機構都有一或多個開放原始碼專案。如果您的機構有獨立的子機構,請分別為每個子機構提交申請與提案。
公司可以提交多項提案申請表嗎?
不可以。每個機構組織只能提交一份申請表。如果貴機構有子機構 (例如貴機構是多個個別開放原始碼專案的基礎),則每個專案都應提交自己的應用程式,即使補助金會由綜合機構處理。
一組開放原始碼專案是否能同時提交提案,以便執行單一文件專案?
一個機構應提交提案申請,並負責協調其他參與專案的工作和支援。(舉例來說,假設有一個小型的開放原始碼專案,這些外掛程式全部適用於某個大型專案,並想針對建立外掛程式的使用指南,選擇一個機構來主導專案)。
我的機構會透過什麼方式收取款項?
貴機構必須擁有開放式統籌帳戶才能獲得資金。
組織參加「文件季」計畫是否能獲得任何報酬?
機構可在專案預算中納入管理、指導或審查工作資金。
我的組織應該如何編列技術撰稿人的費用?
建議您參閱撰寫 Google 文件薪資問卷調查,並列出每小時費率。您也可以加入「Write The Document Slack」,然後在 #season-of-docs 頻道中請感興趣的技術撰寫者出價。
我的機構可以使用「文件季別」授權支付目前的協作者費用嗎?
需要。不過,專案提案必須適用於新工作 (包括維護工作、修訂或現有說明文件的升級)。您可能無法申請補助來支付已完成的工作費用。
我的機構可以和學生技術撰稿人合作嗎?
您可以選擇請學生技術作家著手處理專案,如果您決定與學生合作,我們強烈建議您將課程對象限制為符合下列條件的學生:
- 年滿 18 歲
- 參加技術撰文/技術通訊計畫或課程
- 具備相關專業能力,透過計畫或課程取得技術書面指導
我的機構可以與多位技術撰稿人合作嗎?
您的機構可能會選擇並支付多位技術作者,但與貴機構合作的所有技術撰稿人都必須完成您提議的專案。與多位技術寫入人員合作會讓專案變得更複雜,所需的志工和管理時間也會增加。
我的機構可以聘僱技術寫作公司來參與我們的專案嗎?
可以,貴機構可以聘僱技術寫作公司來處理您的專案。請確認您所僱的公司能透過 Open Collective 收取款項。
我們的技術文件寫手在計畫結束前就退出了。是否還能收到剩餘資金?
強烈建議您在計畫結束前,嘗試尋找新的技術撰寫人員完成專案。不過,剩餘資金並非根據專案完成情況發放,而是在完成個案研究和最終評估。
如果無法完成專案,我們預計會在個案研究中探討原因。舉例來說,您可能發現說明文件工具非常複雜,而且在培訓技術撰寫人員方面遇到困難,或者您的專案需要測試及更新教學課程,而且需要廣泛的程式設計經驗。根據您的經驗,您會向其他專案推薦什麼?請在個案研究中加入這項資訊。
機構申請可以在提交期限前接受審查嗎?
很抱歉,我們無法針對機構申請提供意見。
機構應該如何界定專案提案範圍?
構思專案構想時,請試著找出能為機構帶來價值的最小專案 (但可在時間允許的情況下展開)。越小越好建立專案提案時,建議您採用規模較小且較詳細的專案,而非較不明確的大型專案。如果專案需要大量領域的專業知識,請嘗試納入沒有該背景的人也能執行的專案。
我可以參加《Google 文件季報》的組織管理員,以及擔任 Google Summer of Code 的導師嗎?
需要。「文件季別」和「Google Summer of Code」是兩個不同的計畫。如果您有足夠的頻寬參與這兩項程式,也沒關係。
我們的機構參與了上一季的文件計畫。是否可以再次申請?
是,已參加前一季文件計畫的機構可再次申請。
封存的資料
如何從文件封存檔案中移除我的資訊?
如要移除您的資訊,請與我們聯絡。