專案構想

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

本頁面適用於機構申請程序探索階段的開放原始碼機構。這些專案構想只是示例,說明機構如何在機構的專案構想頁面中說明可能的說明文件專案;機構可以提出不在這個清單中的專案。

專案構想:建立貢獻者新手上路指南

問題

  • 新貢獻者無法找到所需的設定資訊,無法對我們的專案做出有意義的貢獻。有些程序 (例如協助進行測試) 根本沒有記錄。

我們如何評估成效?

  • 新貢獻者人數增加
  • 增加新非程式碼貢獻者的數量 (透過簡化文件或測試的貢獻方式)
  • 新貢獻者提出的問題數量減少
  • 標記為「good first issue」的已關閉問題數量增加

技術作家要具備哪些技能才能參與這個專案?

  • 必備條件:熟悉 GitHub (或願意完成 GitHub 教學課程)
  • 如有下列條件,將更佳:熟悉測試執行程式,以便執行測試並更新相關說明文件

志工

鼓勵社群成員註冊協助處理特定工作,例如:

  • @JaneQDev,可以幫忙回答有關測試的問題嗎?
  • @ChenPCoder,很高興能審查文件提取要求
  • @ErichJEngineer,可以請技術文件撰寫人員介紹目前的貢獻程序嗎?

聯絡資訊

  • 有意參與這項專案的技術作家,請傳送電子郵件至 email@project。加入技術寫作作品或作品集/履歷/履歷表的連結。

專案構想:撰寫教學課程,說明如何使用我們的程式庫與 ...

問題

  • 我們的專案收到許多使用者提出的問題,他們嘗試使用我們的程式庫搭配 $TechnologyX。我們沒有明確的指南說明如何整合 $TechnologyX,這可能會很棘手!

我們如何評估成效?

  • 「$TechnologyX」標記的問題數量減少
  • 新貢獻者提交的提取要求數量增加,協助我們修正錯誤或為 $TechnologyX 相關說明文件增添內容
  • 來自 $TechnologyX 專案的更多專案連結

技術作家要具備哪些技能才能參與這個專案?

  • 建議條件:熟悉 $TechnologyX

志願者

鼓勵社群成員註冊協助處理特定工作,例如:

  • @JaneQDev,可以幫忙回答有關 $TechnologyX 的問題嗎?
  • @ChenPCoder,很高興能審查文件提取要求

聯絡資訊

  • 有意參與這項專案的技術作家,請傳送電子郵件至 email@project。加入技術寫作作品或作品集/履歷/履歷表的連結。

專案構想:重新整理說明文件

問題

  • 我們的說明文件內容龐雜且雜亂無章法。許多使用者放棄在說明文件中尋找答案,轉而直接在論壇中提出問題或提出問題。即使使用相關關鍵字,我們的網頁也不會顯示在搜尋結果中。

我們如何評估成效?

  • 改善說明文件的 SEO
  • 減少說明文件中主題所產生的問題數量
  • 說明文件貢獻次數增加

技術作家要具備哪些技能才能參與這個專案?

  • 具備下列條件者優先:有重新整理大型成熟文件集的經驗,瞭解搜尋引擎最佳化 (SEO)

志工

鼓勵社群成員註冊協助處理特定工作,例如:

  • @ChenPCoder,很高興能審查文件提取要求

聯絡資訊

  • 有意參與這項專案的技術作家,請傳送電子郵件至 email@project。加入技術寫作作品或作品集/履歷/履歷表的連結。

專案構想:執行說明文件 FixIt

問題

  • 我們有許多小錯誤和與說明文件相關的舊問題。我們的社群很樂意提供協助,但需要有人負責安排和執行實際的修正作業。

我們如何評估成效?

  • 已解決的文件相關問題數量
  • 說明文件貢獻者和新貢獻者的數量增加

技術作家要具備哪些技能才能參與這個專案?

  • 建議條件:具備執行說明文件 Fixit 的經驗
  • 具備優異的組織能力

志願者

鼓勵社群成員註冊協助處理特定工作,例如:

  • @ChenPCoder,可以協助整理 Fixit 的影片和即時通訊,並協助尋找其他時區的志工

聯絡資訊

  • 有意參與這個專案的技術作家,請傳送電子郵件至 email@project/open 提出問題,或在我們的論壇中提出問題。加入技術寫作作品或作品集/履歷/履歷表的連結。

專案構想:進行文件稽核

問題

  • 我們不太清楚說明文件的狀態!我們沒有路線圖,也不知道哪些問題最迫切,因此很難優先改善說明文件。我們也有很多過時的內容,應予以刪除或封存。

我們如何評估成效?

  • 建立文件路線圖,並獲得社群的一般核准
  • 減少過時或錯誤的說明文件頁面數量

技術作家要具備哪些技能才能參與這個專案?

  • 加分條件:具備文件稽核經驗

志願者

鼓勵社群成員註冊協助處理特定工作,例如:

  • @JaneQCoder,可以協助協調在社群會議中呈現說明文件路線圖

聯絡資訊

  • 有意參與這個專案的技術作家,請傳送電子郵件至 email@project/open 提出問題,或在我們的論壇中提出問題。加入技術寫作作品或作品集/履歷/履歷表的連結。
  • 宣傳和媒體報導」頁面提供的標誌和其他內容,可供你在談論 Google 文件季時使用。
  • 這部影片來自 2017 年 PyCon Australia 大會,提供一些訣竅,協助您整理文件,讓使用者覺得實用:What nobody tells you about documentation,由 Daniele Procida 製作。