Articles

UI design is a key component of a great developer portal. But what makes a great devportal design? How can you avoid obvious pitfalls? What are UI elements you could use to improve the developer experience (DX) of your devportal?

What Is a Developer Portal? A trust signal for your API. A self-service hub. A dashboard for your API products. A list of endpoints is not enough. We provide you with an infographic to help explain.

Developer portals play not only a technical role, they also play a somewhat obscure commercial role. We don't like to say that this is a commercial site, but actually it is also about promotion. You have to explain what you do – preferably not in a hard-core manipulative way. For that, you need more than reference docs. How to get started? What does that API do? A lot more than just the very technical aspects need to be explained. A less well circulated purpose of developer portals is their being a trust signal. They engender trust by showing how much investment went into building that portal. They have to show that the API services documented on that portal will keep on existing and will get reliable support long term.

What information is absolutely essential on a developer portal? What kind of API documentation do you need? Is there a best practice that can be followed when launching a developer portal? We formulated 11 questions and built 3 mock sitemaps that demonstrate how portals can address the different stages of the developer journey.

Should use cases and case studies be part of your API documentation? They play two crucial roles on a developer portal: They act as social proof for your API product (sales function) and they can be an introduction to more specific, implementation scenario documentation types. We explored these fringe documentation types, both on business sites and developer portals, of 18 API companies with different profiles.

The author examined 23 blogs to explore how they can serve the portal users’ needs throughout the 6 stages of the developer journey.