本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Zulip 開放原始碼團隊聊天服務
- 技術文件撰稿者：
- drrosa
- 專案名稱：
- ReadTheDocs 和 API 說明文件的重構
- 專案長度：
- 標準長度 (3 個月)
Project description
我會著重於兩個領域，並同時處理。其中一項做法就是改善 zulip.readthedocs.io 的品質，避免新貢獻者在過程中遇到混淆及疑惑。理想的結果是，從第一次貢獻內容到熟悉 Zulip 運作方式，這段路徑會清楚且簡潔。我還打算著手處理 zulipchat.com/api、api.md 和 openapi.md，讓其他端點的文件化程序更容易理解。這兩個部分都可能涉及更新/簡化內容、整理文章、新增缺少的開發人員說明文件，以及撰寫/測試程式碼。
這個專案將分為四個階段。第一階段將包括小型熟悉專案、準備工具，以及進一步瞭解目前的文件需求。第二階段的目的是在 Zulip 今年秋季的目標背景下，設定工作結構、指定工作內容，並排定優先順序。接著，我會進入專案的執行階段。我將針對導師和 Zulip 的其他開發人員社群不斷交流意見。最後階段將回顧並視需要修改，並撰寫專案報告。
我認為，在工作期間，由於其他人的工作內容 (包括核心開發人員做出的決定)，某些優先事項和工作可能會有所變動。我認為瞭解如何妥善適應這類變化，是成功的 GSoD 體驗不可或缺的一環。在某些情況下，建議的想法可能會延後實施。一般來說，我會專注於確保自己的工作能為 Zulip 開放原始碼專案帶來整體價值。