What is the MVP for a Developer Portal?

Developer Portals

What is the MVP for a Developer Portal?

December 21, 2017

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.

Read more
The Function of API Use Cases & Case Studies on Developer Portals

Developer Portals

The Function of API Use Cases & Case Studies on Developer Portals

October 25, 2017

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.

Read more
What is the Difference Between API Documentation and a Developer Portal?

Developer Portals

What is the Difference Between API Documentation and a Developer Portal?

August 31, 2017

A developer portal is more than just the documentation for an API. As a sort of self-service support hub, it is a key DevRel tool that helps an organization to provide the best possible developer experience for its APIs. A developer portal has a role in support, marketing, sales, and engineering. A conversation on the #documenting-apis WTD slack channel sparked the idea for this blog post.

Read more
DevRelCon Beijing 2017

Developer Portals

DevRelCon Beijing 2017

August 17, 2017

Seven years ago I had the chance to visit China, and I had a great time exploring the cultural heritage, large cities and gastronomy. So when my talk got accepted for the first DevRelCon in Asia, I was excited to see China again — this time from a professional point of view.

Read more
Treat docs like code

Technology

Treat docs like code

July 27, 2017

On the Write The Docs London meetup in January speakers from leading Git code repositories talked about how their teams dogfood their own tools to do their documentation. Version the Docs covered Bitbucket and GitLab, but we missed a GitHub presentation. To fill this gap, we interviewed Anne Gentle about GitHub, treating docs like code, and community contributions to documentation.

Read more
API Documentation at WTD NA 2017

Developer Portals News & Events

API Documentation at WTD NA 2017

June 1, 2017

The annual North-American Write The Docs conference this year featured 2 API documentation redo presentations:

  1. Lyzi Diamond described Mapbox (formerly a part of Development Seed) documentation automagic in detail,
  2. Sarah Hersh talked about the journey that NPR One undertook towards a new task-based approach for their API's developer documentation.

In this post we aim to give you an account of these presentations.

Read more
Upstream Developer Experience: a Role for Developer Portals in Enterprise API Design - Developer Portal Strategy Part 3

Developer Portals Technology

Upstream Developer Experience: a Role for Developer Portals in Enterprise API Design - Developer Portal Strategy Part 3

May 10, 2017

Most of the time when we talk about developer experience, we mean downstream DX, the experience of developers that implement APIs. But what about the developers that create APIs? In a previous post we wrote about the 8 stakeholders of developer portals, we argued that while the developers that use APIs are important, we shouldn’t forget about the experience of other stakeholders of a developer portal. In this post I’ll explore the experience of one of these audiences - the API developers - and explain what upstream DX is, when it matters, and how you can use a developer portal to improve it.

Read more
Documenting web APIs with the Swagger / OpenAPI specification in Drupal

Developer Portals Technology

Documenting web APIs with the Swagger / OpenAPI specification in Drupal

April 20, 2017

As part of our work to make Drupal 8 the leading CMS for developer portals, we are implementing a mechanism to import the OpenAPI (formerly known as Swagger) specification format. This is a crucial feature not only for dedicated developer portals, but also for all Drupal sites that are exposing an API. Now that it has become much easier to create a RESTful API service in Drupal 8, the next step is to make it more straightforward to create its API reference documentation. That is why we think our work will be useful for site builders, and not just for technical writers and API product owners.

Read more