Skip to content
ADP
API Design PrincipleBETA

[ADP-23] Developer Experience

reviewing phase 1

This article needs more reference and practical content.

The sum of all interactions and events, both positive and negative, between a developer and a library, tool, or API.

The software client (web, application) serves as the interface for normal users, while the API is the interface for developers.

  • How do I use the API to complete my task?
  • How can I use the library?
  • How do I make this code reusable by other developers?
    • Even if you are in a small team with yourself as the only developer, the person working on it three months later (which might be you) will ALWAYS forget why certain design decisions were made.

Design the Developer Experience

  • Naming: Are the variable, function names, and APIs self-descriptive and clear?
  • Consistency: Is there a consistent pattern found, raised, and applied throughout the project?
  • Communication: Is the idea being conveyed smoothly, without obstacles, even if it isn't perfect?

Reference