建立技術撰寫應用程式

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

本頁提供技術文件撰寫人員的提示,說明如何完成應用程式的重要部分,以便參與文件季別。這項資訊有助於在開放原始碼機構選取想在文件季節為《文件季節指導》期間發指導的技術編寫專案時,瞭解開放原始碼機構可能會考慮的因素。

簡介

下列指南通常適用於 Google 文件季度。每個開放原始碼機構可能有特定的評估標準。您可以在提交應用程式前與任何參與的機構聯絡,討論他們的需求並規劃您的專案提案。請參閱技術文件撰寫指南中所述的技術寫入者探索階段。

申請表單

在技術文件寫入階段,技術文件寫入者指南會提供申請表。

提交表單後,在技術撰寫者報名階段 (2020 年 7 月 9 日) 結束之前,您可以繼續更新表單中的資訊。

個人資訊

申請表要求您提供下列個人資訊:

  • 您的姓名:請提供您的全名。說明文件季別不會與開放原始碼機構分享這個名稱,也不會在網站上發布這個名稱。

  • 您選擇的顯示名稱:提供您在參與文件季別時要做為公開 ID 的名稱。強烈建議您不要使用真實的全名做為顯示名稱。在 Google 文件的季別中,您的顯示名稱會分享給您在申請表中指定的開放原始碼機構。「Google 文件的季別」則會在可接受的技術寫作專案清單中, 在網站上發布您的顯示名稱。

  • 您的電子郵件地址:提供與您的 Google 帳戶相關聯的電子郵件地址。(您需要有 Google 帳戶才能參加「第一季文件」您可以使用非 Gmail 電子郵件地址搭配 Google 帳戶使用。 請參閱這篇說明文章)。季別文件會使用您的電子郵件地址與您聯絡,並提供給您使用的網站資源。在 Google 文件的季節,我們會將這個電子郵件地址提供給您在申請表中指明的開放原始碼機構。Google 文件季別不會在網站上發布這個電子郵件地址。

請參閱下文,瞭解文件季別如何使用應用程式表單中的資訊。

技術寫作體驗的相關資訊

當開放原始碼導師和機構管理員檢查專案提案時,他們對您的技術寫作經驗有興趣。您可以透過下列方式提供表單詳細資料:

  • 近期的技術寫作體驗:最多三個項目,其中列出最新的技術寫作角色或工作經驗。如果您有開放原始碼說明文件經驗,請一併提供這類資訊。概述您的角色、角色的責任,以及您完成的工作。可以提供相關的日期。

  • 履歷或 CV 的連結: (選填)。您的履歷或課程別名 (CV) 可公開存取版本的網址。

  • 工作樣本連結: (選用)可公開存取的寫入範例組合網址,或您工作範例的個別連結。

  • 您想加入的其他項目: (選填)您要新增這個應用程式的任何資訊。例如,您是否對技術說明文件感興趣、想參與系列說明文件的原因,或是其他相關體驗。

專案提案

「專案提案」概述您在使用文件季度與所選開放原始碼機構合作時要完成的文件工作摘要。

你最多可以提交三項專案提案。所有專案提案都必須使用同一份申請表單。

花時間構思專案提案,並謹記下列原則。

預備作業:

  • 查看參與的開放原始碼機構清單,並選擇您感興趣的一或多個機構。查看每個所選開放原始碼機構提議的專案構想。

    參與開放原始碼機構

  • 如果感興趣的機構尚未建議任何想法,您可以查看專案提案的一般清單,並根據其中一個提案做出您的想法。你也可以選擇自己想出自己的點子,無論該機構是否已發布任何點子。

  • 與一或多個參與組織聯絡,討論專案構想。如要進行聯絡,請使用參與機構清單中顯示的機構電子郵件地址。初期討論可協助您彙整出良好的專案提案。

申請表單上的專案提案:

  • 「Open source organization name」(開放原始碼機構名稱):輸入您想在文件季度期間合作的開放原始碼機構名稱。這必須是顯示在文件季別網站的其中一個參與計畫機構。

    參與開放原始碼機構

  • Open source project name (開放原始碼專案名稱):這是您在文件季別期間要處理的開放原始碼專案名稱。該專案必須隸屬於文件季別網站上列出的其中一個參賽機構。對於某些機構來說,機構名稱和專案名稱可能相同。

  • 建議技術編寫專案的名稱。設定簡短明確的標題,概述您的提案主要目標。

  • 詳細說明。針對調用的技術寫作專案說明 請盡可能提供詳細資訊您可以視需要在說明欄位中輸入多個段落。以下提供一些應該加入的內容:

    • 針對您提議建立/更新的說明文件提供詳細資訊。如果您打算更新現有文件或網站,請附上連結並說明提議的更新。如果要建立新文件或新網站,請描述內容和目標對象。
    • 說明您提出新說明文件或更新內容的原因。
    • 如果您已與開放原始碼組織的成員討論專案,請加入這些討論結果的摘要。
    • 留意提案使用的語言和風格。開放原始碼機構可能會將這些提案做為評估提案的考量因素。
    • 請勿提供專案說明的連結。說明應包含專案的所有確切詳細資料。開放原始碼機構必須能根據應用程式表單內容選取,而非在其他位置顯示的內容。如果需要連結至其他補充說明的內容也沒關係,但請注意,專案選取只會使用申請表的內容。

申請表上的其他重要欄位

下方是您應在申請表中提供的其他重要資訊指南:

  • 選擇標準長度或長時間執行的專案:說明文件季度文件開發階段的標準期間為三個月。如果專案需要較長的時間,您必須在與您選擇的開放原始碼機構討論後,在申請表中註明這一點。請參閱長時間執行的專案說明。

  • 接受文件季度提示:若技術文件撰寫者想接受原則,則只要完成文件季度的技術撰寫者,就能支付全額費用。請參閱技術寫入者承諾相關資訊。小費為選用項目。如果您不想收到小費,請在申請表中指明您的選擇。

文件季別如何使用申請表中的資訊

本節概述說明文件季度使用應用程式表單中的資訊的方式。本頁先前的章節會詳細說明主要欄位。

資料表會列出主要欄位。表格會針對每個欄位顯示文件季別:

  • 將資訊傳送至您在申請表中指定的開放原始碼機構。
  • 在文件季別網站可接受的技術寫作專案清單中,發布相關資訊。
表單資訊 要與開放原始碼機構分享嗎? 是否顯示在文件季別網站上?
全名
顯示名稱
電子郵件地址
近期的技術寫作體驗
履歷表或 CV 連結
工作範例連結
還有其他想加入的事項
開放原始碼機構/專案名稱
技術寫入專案名稱與說明
長時間執行或標準長度的專案
接受小費

上表所用符號的鍵:

符號 符號的意義

附註

還有幾點需要注意:

  • 提交多個專案提案:您可以提交多個專案提案,但各技術文件季度只接受一個專案提案。您只能提交一份申請表,這份表單最多可以提出三項專案提案。

  • 計畫中的技術寫入專案總數:說明文件季度的總技術寫入專案數量上限為特定上限。瞭解運算單元分配的運作方式。

  • 請查看導師的提示,瞭解如何評估技術撰寫者的提案。瞭解眾多導師的選擇條件,您就能製定出更成功的提案。

  • 如需提交您整季文件應用程式時機和方式的相關程序資訊,請參閱技術文件撰寫指南