專案構想

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

專案構想是開放原始碼機構的建議，供技術文件撰寫人員在文件季期間與導師合作完成的專案。

本頁資訊適用於正在準備專案構想清單的開放原始碼機構管理員和導師。這項資訊對技術文件撰寫人員而言也十分實用，有助於機構參考「第一季文件」的參與情況。

專案範例

以下列舉幾種技術文件撰寫專員能夠處理的專案類型：

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

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

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

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

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

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

上述提案的範疇和規模各有不同，任何專案所需的時間長度取決於多項因素，包括說明文件組合大小、產品複雜度、技術撰寫人員和開放原始碼導師的經驗，以及開放原始碼專案提供的工具和程序等。

上述清單的目標是協助您踏出第一步。您也可以提出其他類型的專案

發布您的專案構想清單

您應將專案構想發布到公開網頁、網誌文章或其他公開可見文件中。

您的專案提案頁面應包含：

  • 您的開放原始碼機構相關資訊：

    • 機構組織名稱。
    • 機構說明。
    • 開放原始碼存放區和/或網站的連結。
    • (選填) 用於與貴機構聯絡，提供文件季度的電子郵件地址。該電子郵件地址必須與您在貴機構的文件季度文件申請表中填寫的電子郵件地址相同。
    • (選用) 機構管理和導師的相關資訊，例如顯示名稱。這些顯示名稱必須與您在機構的文件季別申請表中提供的顯示名稱相同。

  • 向貴機構申請參加 本年度文件季度的公告。 「宣傳並新聞」頁麵包含標誌和其他內容，您可以在討論文件季度時使用。

  • 您的專案構想，包括每個專案提案的下方資訊。

當您為貴機構的文件季度建立應用程式時，您應加入專案構想頁面的連結。

各項專案構想的資訊

每個專案提案必須至少包含下列資訊：

  • 專案名稱：選擇簡明扼要的標題。
  • 說明：所需文件作業的詳細說明。 詳細說明您的初始想法。讓有興趣的技術撰寫專員有機會擴大或精進構想。

  • 相關內容：

    • 需要說明文件的開放原始碼專案連結。
    • 如果您要提出的技術寫作專案涉及更新現有說明文件集，請連結至該說明文件集。
    • 如果您提出教學課程或一組使用指南，請描述需要記錄的功能或用途。
    • 如要提出協作者指南，請連結至任何現有的 README 檔案或其他相關內容 (如有)。如果目前沒有可顯示的內容 也沒關係
    • 附上其他專案中類似說明文件的連結 (如適用)。

專案構想的重要性

您的專案構想有許多種的重要之處：

  • 實現構想有助於貴機構設計必要的說明文件工作，並準備與技術文件撰寫專員合作。
  • Google 計畫管理員可透過專案構想，瞭解技術撰寫者與貴機構建立指導關係時將處理的工作類型。Google 計畫管理員可使用專案構想，判斷機構是否承諾參與《文件季節》及在整個計畫期間指導技術文件撰寫專員。
  • 專案構想會吸引有相關經驗的技術寫入者給貴機構。他們可以使用您建議的專案做為其專案提案的基礎。