Articles

What information will help you outline what content and functionality should be in your portal? When should you integrate with 3rd party systems? Why is information architecture a vital base for your DevPortal?

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.

We wanted to understand the nature of trust issues and to figure out how we can overcome them in order to create a “frictionless” onboarding experience. Here is what we’ve found so far. We hope it’ll be valuable to both users and owners of developer portals.

What makes good API docs? To answer that question and help us build the best possible developer portal for a customer, we performed a small inhouse research and reviewed existing blog posts about best practices. The following is a synthesis of what we found.