Food Delivery Platform Readme Review

昨天[Day 5] Food Delivery Platform 需求檢視分享了作業的需求和以[Day 3] 如何開始Take Home Assignment分享的框架去做需求分析，今天就來看看當時的我是怎麼完成這份作業的。

Github repo

Readme

雖然我沒有擔任過檢查作業的面試官經驗，但我想每個人看作業都會先看Readme，Readme我覺得是git專案中的門面，不管是github, gitlab之類的專案我們第一眼看到的會是Readme而Readme的內容越詳細越會增加我們對這個專案的好感度。
不知道什麼事Readme的可以看這篇What is README.md File?
簡單的專案Readme結構為

• 專案的名稱和描述
• 專案的功能和特性
• 專案的使用方法
• 專案的依賴關係
• 專案的貢獻指南

分享幾個我覺得不錯的Readme

• aimeos-typo3
• zoxide
• nerd-fonts
• Clipboard

現在來review我當時作業的Readme

優點：

• 完整性：README 涵蓋了許多必要的資訊，從安裝依賴到執行API，都有提供。
• 清晰的API說明：對於每個API的功能、參數、方法都有明確的說明。
• 錯誤碼列表：提供特定的錯誤碼與錯誤碼內容。
• 資料庫模型：有提供DB schema model圖。

缺點：

• 結構和格式：整體結構和格式可以更加統一和清楚。例如，使用標題和子標題區分不同的部分。
• 缺乏導覽：因內容較多可以加入目錄，可以快速跳至想了解的部分。
• Code block內容太多：Code block文字敘述太多，不好閱讀。

建議：

• 增加目錄：在開頭提供目錄。
• 結構化API說明：可以使用Swagger 和提供Postman collection。
• 加入系統架構或流程圖：這可以幫助面試官快速了解系統的運作方式。