當前階段:
2021 季的文件計畫已於 2021 年 12 月 14 日結束。請參閱時間表。
本頁資訊適用於處於機構應用程式程序探索階段的開放原始碼機構。這些專案構想只是示例,說明機構如何在機構的專案構想頁面上描述可能的說明文件專案;機構可以提出不在這個清單中的專案。
專案構想:建立貢獻者新手上路指南
問題
- 新貢獻者無法找到所需的設定資訊,無法為我們的專案做出有意義的貢獻。有些程序 (例如協助進行測試) 根本沒有記錄。
我們如何評估成效?
- 新貢獻者人數增加
- 增加新的非程式碼貢獻者人數 (方便使用者參與文件或測試)
- 新貢獻者提出的問題數量減少
- 標記為「適合新手的問題」的已關閉問題數量增加
技術作家要具備哪些技能才能參與這個專案?
- 必備條件:熟悉 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/在論壇中提出問題/提問。請提供技術文件作品或作品集/履歷/CV 的連結。
專案構想:進行說明文件稽核
問題
- 我們不太清楚說明文件的狀態!我們沒有路線圖,也不知道哪些問題最為緊急,因此很難優先改善說明文件。我們也有很多過時的內容需要刪除或封存。
如何評估成效?
- 建立文件路線圖,並獲得社群的一般核准
- 減少過時或錯誤的說明文件頁面數量
技術作家要具備哪些技能才能參與這個專案?
- 加分條件:具備文件稽核經驗
志工
鼓勵社群成員註冊協助處理特定工作,例如:
- @JaneQCoder 可以協助協調在社群會議中呈現說明文件藍圖
聯絡資訊
- 有意參與這個專案的技術作家,請傳送電子郵件至 email@project/在我們的論壇中提出問題/提出問題。請附上技術寫作作品或作品集/履歷/履歷表的連結。