專案構想

目前階段:
已公布結果。請參閱時間表

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

Project Idea:製作貢獻者入門指南

問題

  • 新貢獻者無法找到必要的設定資訊,無法對專案做出有意義的貢獻。我們不會記錄某些程序 (例如參與測試的貢獻) 。

我們如何評估成效?

  • 新貢獻者人數增加
  • 增加非程式碼貢獻者的人數 (簡化在文件或測試中貢獻心力)
  • 減少新貢獻者遇到的問題數量
  • 標記為「第一次問題良好」的結案問題數量增加

技術文件撰寫者需要具備哪些技能,才能處理這個專案?

  • 必須:熟悉 GitHub (或願意透過 GitHub 教學課程進行工作)
  • 建議條件:熟悉測試執行工具,以便執行測試及更新說明文件,瞭解如何進行測試

志工

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

  • @JaneQDev 可協助解答有關測試的問題
  • @ChenPCoder,我們很樂意審查文件提取要求
  • @ErichJEngineer 可以和技術文件撰寫者逐步介紹目前的貢獻過程

聯絡資訊

  • 有意處理這個專案的技術寫入者應傳送電子郵件至 email@project。請附上您的技術寫作作品或系列作品/résumé/CV 的連結。

Project Idea:撰寫教學課程以使用我們的資料庫 ...

問題

  • 使用者嘗試將我們的程式庫與 $TechnologyX 搭配使用時,我們發現許多問題發生。我們沒有明確的指南說明如何整合 $TechnologyX,這可能對您有點困難!

我們如何評估成效?

  • 「$TechnologyX」標記的問題數量減少
  • 來自新貢獻者協助我們修正錯誤或增加 $TechnologyX 說明文件的數量增幅
  • 更多 $TechnologyX 專案的連結

技術文件撰寫者需要具備哪些技能,才能處理這個專案?

  • 必備條件:熟悉 $TechnologyX

志工

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

  • @JaneQDev 可協助解答 $TechnologyX 的相關問題
  • @ChenPCoder,我們很樂意審查文件提取要求

聯絡資訊

  • 有意處理這個專案的技術寫入者應傳送電子郵件至 email@project。請附上您的技術寫作作品或作品集/履歷/CV 連結。

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

問題

  • 說明文件內容龐大且井然有序。許多使用者放棄在說明文件中尋找答案,而改為在我們的論壇中提問或提問。即使搜尋的關鍵字與網頁相關,我們也不會在搜尋結果中顯示這些網頁。

我們如何評估成效?

  • 提升說明文件的搜尋引擎最佳化 (SEO) 成效
  • 減少說明文件中提及的主題數量
  • 文件貢獻數增加

技術文件撰寫者需要具備哪些技能,才能處理這個專案?

  • 建議做法:重新編排大型及成熟的說明文件組合,以及對搜尋引擎最佳化 (SEO) 的瞭解

志工

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

  • @ChenPCoder,我們很樂意審查文件提取要求

聯絡資訊

  • 有意處理這個專案的技術寫入者應傳送電子郵件至 email@project。請附上您的技術寫作作品或作品集/履歷/CV 連結。

專案構想:執行說明文件修正

問題

  • 我們有許多與說明文件相關的小錯誤和舊問題。我們的社群成員都很樂意挺身而出,協助清理工作,但我們需要有人來整理及執行實際修正項目。

我們如何評估成效?

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

技術文件撰寫者需要具備哪些技能,才能處理這個專案?

  • 必備項目:執行說明文件修正的經驗
  • 良好的組織技能

志工

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

  • @ChenPCoder 可以協助整理影片和即時通訊來找出問題,並協助在其他時區尋找志工

聯絡資訊

  • 有意處理這個專案的技術撰寫者應傳送電子郵件至 email@project/open an 問題/詢問我們的論壇。請附上您的技術寫作作品或作品集/履歷/CV 連結。

專案構想:執行說明文件稽核

問題

  • 對我們說明文件的狀態不太瞭解!由於我們沒有發展藍圖或最迫切的問題,因此很難優先改善說明文件。此外,我們也應刪除或封存許多過舊的內容。

我們如何評估成效?

  • 建立文件發展藍圖,經社群進行一般核准
  • 過時或不正確的說明文件頁面數量

技術文件撰寫者需要具備哪些技能,才能處理這個專案?

  • 建議事項:具備文件稽核功能的經驗

志工

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

  • @JaneQCoder,就能在社群會議中協調展示文件藍圖

聯絡資訊

  • 有意處理這個專案的技術撰寫者應傳送電子郵件至 email@project/open an 問題/詢問我們的論壇。請附上您的技術寫作作品或作品集/履歷/CV 連結。