Skip to main content

Articles

Everything on developer portals from strategy and business to technology and visual design.

Sign up to our newsletter to make sure you don't miss out.

by Kathleen De Roo 7 years 7 months ago

FAQs, Forums and Other Support Resources

Self-service support is arguably the most important role of a developer portal. In absence of proper documentation, API teams can spend hours on training, onboarding, and support effort. In this post we analyze the characteristics of a number of support resources and look at how they involve their users to develop information about the problem areas for an API’s use.
Categories: UX & Research
by Kathleen De Roo 7 years 7 months ago

Reference Pages

Once a developer knows how to use your API, they will need detailed instructions on how to build the actual integration. Experienced developers already familiar with an API, including its creators, will have a hard time completing an integration without access to the API reference. In this post we’ll show how the developer portals in our research sample implemented their reference pages, compare their formats and labels, and try to deduct best practices you could apply on your developer portal.
Categories: UX & Research
by Kathleen De Roo 7 years 8 months ago

Guides and Tutorials

The function of the guides and tutorial pages that are linked from an onboarding page is to fulfill the expectation of learning and to design an experience that will be as close as possible to the learning requirements of key audience segments. In this post, we will explore how the sites we reviewed included guides and tutorials in their information architecture, we’ll look at what they covered, and finish with listing what could help to maximize their effectiveness.
Categories: UX & Research
by Kathleen De Roo 7 years 8 months ago

Onboarding Pages

Onboarding pages need to hook the developer. In this article we’ll list the various roles onboarding pages need to fulfill, explore how the developer portals we reviewed expose them and how they are labelled.
Categories: UX & Research
by Kathleen De Roo 7 years 8 months ago

Overview Pages

The "Overview Page" provides a devportal with an entrance page for developers to start exploring. What are strategies to structure information? What is the function of your developer portal? What to know to build an appealing overview page.
Categories: UX & Research
by 7 years 9 months ago

Writing as a non-native speaker

This blog post is about my methods for becoming a better writer in English. It shows my tricks for self-improvement. I don’t want to pretend I have accomplished my goal: I’m still on the road and I have a lot to learn. But I hope this writing could be of help to others with the same challenges.
Categories: UX & Research

Newsletter

Articles on devportals, DX and API docs, event recaps, webinars, and more. Sign up to be up to date with the latest trends and best practices.

 

Subscribe