本頁詳細說明 Google 文件季度接受的一項技術撰寫專案詳細資料。
專案摘要
- 開放原始碼組織：
- 開啟食物資訊
- 技術撰稿人：
- FutureOfDoc
- 專案名稱：
- 記錄 Open Food Facts API
- 專案長度：
- 長期跑步 (5 個月)
Project description
我第一次透過講師電子郵件收到了「Google 文件季度」的相關概念，我幾個月前曾收到一堂課介紹 REST API 文件。雖然我很喜歡這個想法，但我決定加入，只有真能認同的專案才能參與計畫。除了日常工作外，我還需要處理其他事情。如果要這麼做，他們一定很有趣且有意義。
閱讀 Open Food Facts 的說明時，我知道有這項專案。 我喜歡透過運動和食物照顧自己的身體與健康。我認為營養是美好生活的一大關鍵，而我們都應該能夠做出更好的選擇，而對於我們使用的食物和化妝品有足夠的資訊，我們才有辦法做出更好的選擇。Open Food Facts 透過我們的處理
過去三年來，我擔任軟體開發公司的技術文件撰稿人，專門進行程序和發布自動化。同時，我們也已實作具有 Swagger 的 REST API，讓開發人員透過 API 要求與我們的應用程式進行通訊。我們協助開發團隊針對要求/回應撰寫更佳的說明，也已經找出客戶需要哪些資訊，以清楚簡要的方式提供。
我已審查目前的 Open Food Facts API 網站，相信我們可以重新建構及強化說明文件，使其更易於使用 (一般、讀取、寫入頁面)。此外，我很樂意與開發團隊一起設定，透過程式碼自動產生 API 說明文件。為此，我建議長期合作。
我們都知道看似重要 ;) 因此，我們也調整 REST API CSS 和標誌，讓 Swagger UI 與使用者說明文件一致。
我們非常期待與您合作，共同推動這個專案！