Skip to content
ADP
API Design PrincipleBETA

[ADP-23] 開發者體驗

reviewing phase 1

這篇文章需要更多參考資料以及實際內容。

開發者與程式庫、工具或 API 之間所有互動和事件的總和,包括正面和負面的體驗。

軟體客戶端(網頁、應用程式)是普通用戶的介面,而 API 則是開發者的介面。

  • 我如何使用 API 完成我的任務?
  • 我如何使用這個程式庫?
  • 我如何讓這段程式碼能被其他開發者重複使用?
    • 即使你是一個小團隊中唯一的開發者,三個月後工作在這個專案上的人(可能是你自己)總是會忘記為什麼做出某些設計決策。

設計開發者體驗

  • 命名:變數、函數名稱和 API 是否具有自描述性和清晰度?
  • 一致性:是否在整個專案中發現、提出並應用了一致的模式?
  • 溝通:即使不完美,想法是否能夠順暢地傳達,沒有障礙?

參考資料