技術文件撰寫指南

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

本頁內容為參與說明文件季別的技術撰稿者指南。

簡介

歡迎閱讀整季文件!本指南可讓您稍微瞭解 Google 文件季的參與程度,並協助您完成計畫每個階段中應完成的活動。

參與「文件季別」的參加資格

如要以技術文件撰寫者的身分加入「文件季別」,您必須符合下列條件:

  • 註冊時須年滿 18 歲。
  • 能夠提交角色說明和工作樣本,展現以往的技術寫作經驗。
  • 在計畫期間,有資格在居住國家/地區工作。
  • 現任美國居民,但目前未在美國禁制的國家/地區。 請參閱美國財政部的制裁計畫與國家/地區資訊

查看完整的技術文件撰稿人條款

開放原始碼導師

文件的系列導師不一定是技術文件撰寫專員,他們在技術通訊方面可能很少有經驗。他們是開放原始碼組織的成員,瞭解優質說明文件的價值,以及熟悉開放原始碼程序和工具的人員。

你與導師的關係是彼此合作的。您能夠將說明文件經驗和技能投入開放原始碼的機構。您的導師貢獻了對於開放原始碼和程式碼的知識。您可以一同開發技術說明文件,並改善開放原始碼專案的程序。

計畫公告和機構申請階段

文件季度公告日期為 2020 年 3 月 23 日。歡迎有興趣的開放原始碼機構提出申請,在 2020 年 4 月 13 日至 2020 年 5 月 4 日期間參加文件季。Google 計畫管理員會在 2020 年 5 月 11 日發布成功的機構組織清單。

在計畫公告和參與開放原始碼機構發布這段期間的期間,建議你密切留意最新消息。您可以返回此網站,並觀看網路上的網誌文章或其他新聞。即使在機構應用程式階段,部分開放原始碼機構也可能分享想法。

我們也鼓勵您分享關於文件季別的介紹,以及您對這項計畫感興趣的原因。查看促銷內容,瞭解圖片與概念。

技術文件撰稿人探索階段

技術文件撰寫者探索階段的執行時間為 2020 年 5 月 11 日至 6 月 8 日。在這段期間,您可以瀏覽 參與組織的機構清單與他們的專案想法。這是一項技術文件撰寫人員的開放通話,無須取得各季文件的核准即可開始使用。另外請注意,符合上述資格規定

當您找到一或多個感興趣的專案時,您應直接與相關開放原始碼機構聯絡,討論專案構想。

您在這個階段擔任技術寫入者的工作

探索參與的開放原始碼機構清單,以及他們的專案構想。

檢查清單,找出您想合作的開放原始碼機構。查看機構提出的技術寫作專案,並判斷哪些專案適合您。您可以為多個機構提出申請。在文件季的這個階段中,建議您探索多種選項。最終選取程序只接受每個技術寫入者一項專案。

參與開放原始碼機構

與開放原始碼機構討論專案構想。

您可以與參與計畫的任何機構討論專案構想。如要聯繫,請使用參與機構清單中顯示的機構電子郵件地址。早期討論可協助您擬定完善的專案提案,以便在技術文件撰寫階段提供給 Google 計畫管理員。初始專案的構想可能來自機構提議的構想清單。您也可以提出自己的想法。

參與開放原始碼機構

技術寫作專案構想

技術文件文件撰寫階段

技術文件寫入階段為 2020 年 6 月 9 日至 2020 年 7 月 9 日。在這段期間,您可以申請參加「文件季別」。Google 計畫管理員會將應用程式的相關詳細資料轉送至所選的開放原始碼機構。開放原始碼組織管理員和導師,然後選取要指導的專案。

您在這個階段擔任技術文件寫入者的工作

提交您的申請,就有機會參加該季文件。

請在 2020 年 7 月 9 日前提交您的文件季度申請,

建立應用程式

2020 季的文件技術文件撰寫人員現已截止報名。season-of-docs-announce 中加入公告郵寄清單,隨時掌握最新消息。

社區凝聚階段

社群凝聚階段於 2020 年 8 月 17 日至 9 月 13 日。在此期間,開放原始碼導師可協助您熟悉開放原始碼專案和社群。

您在這個階段擔任技術寫入者的工作

設置溝通管道。

在您選擇合作的開放原始碼機構中,與導師聯絡。請確保您以可靠的方式與輔導老師和機構管理員直接溝通;後者是開放原始碼組織的成員,擔任機構的文件主要聯絡窗口。

您應負的責任

導師的責任

與技術文件撰寫專員合作的導師指南

參與開放原始碼專案和社群。

向導師詢問開放原始碼機構使用的工具與程序相關問題。自我介紹開放原始碼社群的郵寄清單、即時通訊、Slack 頻道,以及任何其他共用通訊管道。

瞭解產品整體。

請導師說明即將記錄的產品,尤其是從概念上。詳細說明說明文件的目標對象。

設定目標和期望。

請與導師合作,修正技術寫作專案的目標,並設定雙方的期望。立即設定這些目標和期望,是確保專案成功的好方法。

文件開發階段

文件開發階段的執行期間為 2020 年 9 月 14 日至 2020 年 11 月 30 日。(結束日期對於長時間執行的專案不同)。在此期間,您將與導師密切諮詢建立專案。

您在這個階段擔任技術寫入者的工作

請與導師合作完成專案。

請與你的導師密切合作,以完成專案。請按照開放原始碼社群的程序要求審查產生的說明文件,以及將更新提交至開放原始碼存放區。舉例來說,託管於 GitHub 的開放原始碼專案會建立或更新檔案,以便建立審查和提交提取要求

並與機構管理員分享任何疑慮。

如果您對與導師的溝通有任何疑問,或遇到任何其他可能影響專案順利完成的問題,請告知開放原始碼機構的系統管理員。

您應負的責任

填寫 Google 計畫管理員提供的任何問卷調查。

Google 計畫管理員可能會在專案進行中填寫問卷調查,以便評估進度。按照問卷調查文件中的指示完成問卷調查,並將回答提交給 Google 計畫管理員。

專案完成和評估階段

專案最終階段會在 2020 年 11 月 30 日至 12 月 5 日期間執行,評估階段則為 2020 年 12 月 3 日至 10 日。(長時間執行的專案的日期不同)。在專案最終化期間,您可以提交專案報告,也稱為「最終工作產品」。在評估階段,您可以提交有關導師的評估結果,以及您身為 文件季參與者的體驗。

您在這個階段擔任技術寫入者的工作

編寫專案報表。

編寫專案報表 (有時稱為工作產品)。專案報告包括您在 Google 文件季度工作的說明,以及任何相關連結。

建立專案報表

長時間執行的專案終結階段已結束。

請導師查看專案報告。

你的導師可能有關於如何描述成就的寶貴資訊。此外,在導師將專案標記為已順利完成前,在這個階段掌握專案狀態的共同理解,就能派上用場。

完成專案報表。

請於世界標準時間 2021 年 3 月 8 日 18:00 前完成專案報告。 您可以編輯表單,但必須在指定日期前提交最終版本。

長時間執行的專案終結階段已結束。

為導師撰寫並提交評估資料,以及你的文件季度體驗。

請在世界標準時間 2021 年 3 月 12 日 18:00 前完成並提交評估作業。

技術文件撰寫專員的評估

您應負的責任

長時間執行的專案評估階段已關閉。

長時間執行的專案

針對文件季度的標準技術撰寫專案,文件開發階段是從 2020 年 9 月 14 日到 2020 年 11 月 30 日。不過,有些技術寫入者可能會申請長時間執行的專案與開放原始碼機構合作。針對長時間執行的專案,文件開發階段會在 2020 年 9 月 14 日至 2021 年 3 月 1 日間執行。

長期執行專案的專案最終化與評估期間為 2021 年 3 月 1 日至 8 日。

您的工作和責任與本頁所述,內容與本頁所述內容相同,但專案最終和評估的預計日期晚於之後。