本頁面包含 Google 技術文件季度接受的技術寫作專案詳細資料。
專案摘要
- 開放原始碼組織：
- Open Food Facts
- 技術撰稿人：
- FutureOfDocs
- 專案名稱：
- 記錄 Open Food Facts API
- 專案長度：
- 長時間跑步 (5 個月)
Project description
我第一次聽到「說明文件季」這個詞，是透過幾個月前參加的 REST API 說明文件課程講師寄來的電子郵件。雖然我很喜歡這個想法，但我決定只有在能確實認真參與某項專案時，才會提出申請。這是我除了正職之外會做的事，如果我做了這件事，一定是既有趣又有意義。
當我讀到 Open Food Facts 的說明時，就知道自己找到了這個專案。我喜歡透過運動和食物照顧自己的身體和健康。我認為營養是快樂生活的關鍵之一，我們都應該做出更明智的選擇，而要做到這一點，就必須充分瞭解自己食用和使用的食品和化妝品。Open Food Facts 提供這項資訊供我們使用，而我希望能為這項優異的計畫盡一份心力。
過去三年，我在一家專門從事流程和版本自動化的軟體開發公司擔任技術文件撰寫專員。此外，我們也透過 Swagger 實作了 REST API，方便開發人員透過 API 要求與我們的應用程式進行通訊。我協助開發團隊為要求/回應撰寫更詳盡的說明，並與他們共同確認客戶需要哪些資訊，以便以清晰簡潔的方式提供這些資訊。
我一直在審查目前的 Open Food Facts API 網站，我認為我們可以重新調整及強化說明文件，讓說明文件更易於使用 (一般、讀取、寫入頁面)。此外，我很樂意與開發團隊合作，設定自動從程式碼產生 API 說明文件的方法 (這需要花費時間，因此我建議長期合作)。
我們都知道看起來很重要 ;) 所以我們也可以調整 REST API CSS 和標誌，讓剪接工具的使用者介面與使用者說明文件保持一致。
期待能與你合作完成這個專案！