本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Open Facts
- 技術文件撰寫者：
- FutureOfDocs
- 專案名稱：
- 記錄 Open Food Facts API
- 專案長度：
- 長時間執行 (5 個月)
Project description
我在幾個月前參加了一份有關 REST API 文件的課程，但我第一次透過該封電子郵件得知「文件季別」。雖然我真的很喜歡這個想法，但決定只有在我能和他們真正談到的的情況下，才能報名參賽。除了一般工作以外，我也會採取什麼動作，但只要做到這一點，一定很有趣且有意義。
閱讀開放食物的事實說明時，我發現自己發現了這個專案。 我喜歡透過運動和食物來照顧自己的身體與健康。我認為營養是快樂生活的關鍵之一，而我們都應該能夠做出更好的選擇，而除非我們擁有足夠的食物和化妝品資訊，才能做出可能。Open Facts 將這些資訊放在我們手中，希望能貢獻一己之力，為這項無窮的計畫盡一份心力。
過去三年來，我擔任軟體開發公司的技術文件撰寫專員，該公司專門負責流程和版本自動化處理。此外，我們還利用 Swagger 實作 REST API，讓開發人員可以透過 API 要求與應用程式通訊。我已協助開發團隊為這些要求/回應撰寫更清楚的說明，並歸納出客戶需要哪些資訊，以清楚簡潔的方式提供。
我們已經審核目前的 Open Food Facts API 網站，認為我們可以調整文件結構並改善說明文件，讓使用者更容易使用 (一般、讀取、寫入頁面)。此外，我也想與開發團隊一起設定，透過程式碼自動產生 API 說明文件 (這需要時間，這也是我提議長久合作的原因)。
我們知道看起來很重要 ;) 因此，我們還可以調整 REST API CSS 和標誌，使其符合使用者說明文件中的 UI。
非常期待能與您合作完成這個專案！