本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Zulip 開放原始碼團隊即時通訊
- 技術文件撰寫者：
- Drrosa
- 專案名稱：
- 重構 ReadTheDocs 和 API 文件
- 專案長度：
- 標準長度 (3 個月)
Project description
我會著重於兩個區域，並同時針對這兩個區域進行研究。其中一項方法是改善 zulip.readthedocs.io 的品質，讓新的貢獻者在學習過程中能夠減少困惑和疑惑。從首次貢獻，到熟悉 Zulip 的運作方式，結果都有明確且簡單明瞭的路徑。我也計劃在 zulipchat.com/api、api.md 和 openapi.md 上工作，以讓記錄其他端點的程序更容易理解。這兩個部分都可能涉及更新/簡化內容、整理文章、新增缺少開發人員說明文件，以及編寫/測試程式碼。
這項專案分為四個階段。第一階段包含熟悉的小規模專案、預備工具，以及對目前的文件需求有更充分的瞭解。第二階段的目標是根據 Zulip 今年秋季的目標，根據 Zulip 的目標規劃、指定並排定工作的優先順序。然後進入專案的實作階段。我會再與導師和 Zulip 其他開發人員社群交流，汲取寶貴的意見。最後一個階段是回顧、視情況修改及撰寫專案報告。
我懷疑有些優先事項和任務可能會因為其他人在進行其他工作 (包括核心開發人員的決策) 而改變。我認為學會如何適應這些變化，才能獲得良好的 GSoD 體驗。某些時候，您可以延後提案供日後繼續參考。一般來說，我會著重在確保 Zulip 開放原始碼專案的整體成效能夠為我的成果帶來價值。