7 Trust Signals That Help an API Succeed - Developer Portal Strategy Part 1

Technology

7 Trust Signals That Help an API Succeed - Developer Portal Strategy Part 1

January 25, 2017

Developer portals are important for your API's adoption and support. They are also a trust signal: a well designed and actively maintained developer portal shows that an organization is investing in its APIs. It helps convince developers that they can rely on them. In this post I’ll zoom in on the trust signals business model, partner policy, API quality, API uptime status, versioning policy, documentation and developer portal production quality.

Read more
Graph databases in Drupal: a Neo4j module that integrates with Rules

Technology

Graph databases in Drupal: a Neo4j module that integrates with Rules

January 13, 2017

SQL databases are really fast when you need all the information stored together in a record row, but they are a bad fit when you need to search for relationship patterns that are not already stored together in your database. A significant performance penalty is incurred for every additional table that needs to be joined for a query. That is why SQL databases are notoriously bad at deducting relationships from datasets. Graph databases however are really good at this task.

Read more
Developer Portal Components - Part 6: Software Development Kits (SDKs)

Technology

Developer Portal Components - Part 6: Software Development Kits (SDKs)

December 23, 2016

The main purpose of Platform Software Development Kits and Helper/Client Libraries is to accelerate and simplify development. A well maintained SDK is a trust signal that indicates the level of support and usage of your API for a language, framework, or development platform. So indirectly SDKs work as social proof, indicating how many communities are already using your API.

In this post, we’ll look at how the developer portals in our research sample included SDKs. We’ll examine their functions, describe where we found them in the site architecture and deduct best practices. We’ll discuss what kind of SDKs the Portals in our sample used. We’ll analyze their choices and evaluate them against the principles that Taylor Barnett from Keen IO shared at APIstrat earlier this year. We’ll also talk about the strategic choices that need to be made when deciding what kind of SDKs an API should have.

Read more
5 Things to Learn from Twilio’s documentation overhaul

Technology

5 Things to Learn from Twilio’s documentation overhaul

December 13, 2016

Twilio is regarded as one of the API industry’s leaders, so when, after five years, Twilio changes the documentation format on their developer portal, everybody wants to know why. Jarod Reyes and Andrew Baker (both developers of Twilio's developer education team) gave a presentation about the reason for the changes at SIGNAL 2016. Because we found them valuable and wanted to share them with our developer portal mailinglist, we’ll summarize their findings in this blog post.

Read more
Developer Portal Components - Part 5: FAQs, Forums and Other Support Resources

Technology

Developer Portal Components - Part 5: FAQs, Forums and Other Support Resources

November 23, 2016

Self-service support is arguably the most important role of a developer portal. Without proper documentation, API teams will spend countless hours on introduction workshops and other training and support efforts.

In this post we’ll analyze the characteristics of a number of support resources and look at how they involve users to develop information about the problem areas in an API’s use. We’ll list pros and cons for the different resources, look at their place in the site architecture, and finally propose best practices.

Read more
Developer Portal Components - Part 4: Reference Pages

Technology

Developer Portal Components - Part 4: Reference Pages

November 17, 2016

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.

Read more
Developer Portal Components - Part 3: Guides and Tutorials

Technology

Developer Portal Components - Part 3: Guides and Tutorials

November 2, 2016

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.

Read more