專案構想

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

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

專案提案:製作貢獻者入門指南

問題

  • 新貢獻者找不到設定資訊,無法為我們的專案做出有意義的貢獻。部分程序 (例如參與測試) 則完全不會記錄。

我們如何評估成效?

  • 新貢獻者人數增加
  • 非程式碼的新貢獻者數量增加 (簡化文件或測試的貢獻)
  • 新貢獻者提出的問題數量減少
  • 標示為「好優先問題」的已關閉問題數量增加

技術撰寫人員需要哪些技能來進行這項專案?

  • 必備項目:熟悉 GitHub (或願意參加 GitHub 教學課程)
  • 建議項目:熟悉我們的測試執行工具,以便執行測試並更新用於測試的說明文件

志工

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

  • @JaneQDev 可協助回答測試相關問題
  • @ChenPCoder,我很樂意審查文件提取要求
  • @ErichJEngineer 能與技術撰稿人一起逐步瞭解目前的貢獻程序

聯絡資訊

  • 對於有意參與這項專案的技術寫入者,應傳送電子郵件至 email@project。請提供技術撰文作品或作品集/履歷表/CV

Project Idea:撰寫教學課程並使用 ...

問題

  • 我們的專案在 $TechnologyX 中使用我們的程式庫時,發生許多問題。我們目前沒有與 $TechnologyX 整合的明確指南,這可能不是件容易的事!

我們如何評估成效?

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

技術撰寫人員需要哪些技能來進行這項專案?

  • 建議條件:對 $TechnologyX 有一定程度的瞭解

志工

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

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

聯絡資訊

  • 對於有意參與這項專案的技術寫入者,應傳送電子郵件至 email@project。請提供您的技術撰文作品或作品集/履歷/履歷表的連結。

Project Idea:重新整理說明文件

問題

  • 我們提供的說明文件內容十分豐富,井然有序。許多使用者願意在說明文件中尋找答案,然後只是在論壇中提出問題或提問。即使有人搜尋相關的關鍵字 網頁也不會出現在搜尋結果中

我們如何評估成效?

  • 改善說明文件的搜尋引擎最佳化 (SEO)
  • 針對說明文件涵蓋的主題減少問題數量
  • 文件貢獻數量增加

技術撰寫人員需要哪些技能來進行這項專案?

  • 建議條件:曾為大型和成熟的說明文件集重新編排、瞭解 SEO 作業

志工

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

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

聯絡資訊

  • 對於有意參與這項專案的技術寫入者,應傳送電子郵件至 email@project。請提供您的技術撰文作品或作品集/履歷/履歷表的連結。

Project Idea:執行說明文件修正

問題

  • 我們有一些與說明文件相關的小錯誤和舊問題。我們樂於向社群推薦及協助清理資料,但需要有人負責整理並執行實際的修正。

我們如何評估成效?

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

技術撰寫人員需要哪些技能來進行這項專案?

  • 建議條件:執行說明文件修正的經驗
  • 良好的組織技能

志工

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

  • @ChenPCoder 可彙整影片和即時通訊內容來修正問題,並協助尋找其他時區的志工

聯絡資訊

  • 對於有意參與這項專案的技術內容撰寫人員,應傳送電子郵件至 email@project/在論壇中提出問題/要求。請提供技術寫作作品或作品組合/履歷/履歷表的連結。

專案提案:進行文件稽核

問題

  • 我們對說明文件的狀態不清楚!我們沒有製定藍圖或瞭解最迫切的問題,因此很難安排文件改善項目的優先處理順序。也有許多過時內容應刪除或封存。

我們如何評估成效?

  • 納入社群一般核准的說明文件藍圖
  • 過時或不正確的說明文件頁面數量減少

技術撰寫人員需要哪些技能來進行這項專案?

  • 適用項目:有進行文件稽核的經驗

志工

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

  • @JaneQCoder,可在社群會議中共同提出說明文件藍圖

聯絡資訊

  • 對於有意參與這項專案的技術內容撰寫人員,應傳送電子郵件至 email@project/在論壇中提出問題/要求。請提供技術寫作作品或作品組合/履歷/履歷表的連結。
  • 宣傳與新聞頁麵包含標誌和其他內容,您可以在談論 Google 文件的季別時使用。
  • 這部來自 PyCon Australia 2017 的影片提供瞭如何整理說明文件的提示,讓人們可以找到實用的文件:Daniele Procida 的「What nobody to about the 說明文件」