The DevPortal Awards bring together the API community to recognize, celebrate and learn from the world’s greatest developer portals and their API documentation. Ellis is one of the judges.
In this episode of the Cherryleaf Podcast, he talks about the criteria the awards use to assess the different developer portals.
Hello and welcome to the Cherryleaf Podcast.
Is November 2020. We’re still in the lock down. In fact, the parks are still open. I thought I’d take the opportunity to do another walking podcast. In fact, I’m along the river bank of the Thames between Staines.
On my left is the River Thames, which you may hear.
And the seagulls above.
And there’s some posts.
In the River and on two of the posts are some very large black birds with yellow beaks, so I don’t know what they are and to my rights are houses, people that live by the river bank.
So let’s just walk on and this time.
What I thought I would talk about is the Developer Portal Awards, which are coming up on the 25th of November.
So there are 14 nominees.
For best Design 6 nominees for Best API, Business model and nine nominees for Best Developer Dashboard. So let me explain my involvement with that. So there is a jury and the jury’s task is to evaluate submitted developer portals along certain criteria.
And select the winners for those different categories.
There is 1 judge who is Emmeline Wang, who is a global digital business strategy leader. Some of you, if you’re involved with APIs, may well have heard of her. She’s quite well-known. She’s reviewing and selecting the winner for the best design, Best API, business model, and best developer dashboard categories.
And also involved with the best overall category and Doctor Bob Watson is another jury member. He’s a senior technical writer at Amazon Web Services in Seattle.
And the third juror is is me.
And what I’d like to do, not so much talk about who’s likely to win that decision is not been made yet, but more about the decision making criteria. How do you decide what makes a good API? And this competition is hosted by a company called Pronovix which is based in Belgium and in Hungary.
And they’ve given the jury members some guidance on what to look for, how to judge things. One part is we’ve identified 3 dimensions that API teams can work on to improve the business value of their developer portal.
One operational maturity does your developer portal working synergy with all your authoring personas.
Are there some or everyone who needs to push through significant friction to be able to contribute to your developer portal?
2 developer experience. How well does your developer portal serve your API customers? Have you removed as much friction as possible?
From the integration journey, have you incorporated trust signals to help them make their interface investment decisions?
And three business alignment is your developer portal and it solution that helps you to execute on your API program or have you worked on an interface strategy that complements your business and that will help your company to adjust to and thrive in a complex and always changing markets.
So I’ve stopped walking. I will restart in second, but I’m actually to sign ’cause I’m at Penton Hook lock.
So I’m on the Thames Path that ends.
Thames Path National Trail is one of a family of long distance routes.
And it follows the River Thames, 180 miles from its source in Gloucestershire.
To the City of London, ending at the Thames Barrier.
And I’m at the bits which is near Staines. This is the highest of stream of the lots built by the Corporation in the City of London. The Lock Keepers house was built in 1814 and the date could be seen on the city coat of arms in the front of the building.
If you travel along the Thames, you’ll notice that each lock has a house for its resident log keeper. These were built two different designs, often reflecting the local vernacular. This design only survives here, and that somebody lock.
So this will come yes, I’m only a lock in that endpoint and hook lock. If you ever saw the Monty Python sketch where.
Somebody was thrown into a lock while having their face slapped around with a fish. It looks similar to that sort of lock so I can get across onto Penton.
If not, we will go along the river bank anyway.
So what we’ve been asked to do is yours is to look at the different entries for the different categories that people are looking at.
It’s over the.
Look, there’s a bunch of stuff going to look.
And then write the different entries.
On a scale of 1 to 5.
So one category is best overall mature dev portals Excel in UX and DX from both an internal an external angle. They take care of the authoring and publishing experience and they will fast first API call have an active community.
Provide a personalized experience upon login. Performed well regarding self-service for both novices and experienced users.
Let’s just go somewhere.
OK often relevant docs for decision makers.
And developers innovated how to present and consume content, promote interactive materials, shared code samples in multiple languages.
Redundantly and ensure that the chosen environment, such as platform marketplace, takes the utmost care of differentiated audiences.
Last but not least, great developer portals also serve a clear business purpose. They provide that organization with the tools and space to experiment, learn and develop new business opportunities.
So I’m just going onto an island in the middle of the Thames.
Pass this way, which is why it’s so noisy. Let me get past that bit quieter. So one of the categories I’ve been asked to judge entries for is the best accessible API portal.
And the guidance that I was given was Def portals that take the initiative to make their API’s and documentation accessible.
To all possible users, regardless of disability, type of severity of impairment.
Summer valuation criteria are appropriate code content to support different learning paths. For example, tutorials, we text visuals and code snippets.
API documentation supporting with concept 1st and code learning strategies.
Easy to complain content, so no lengthy or complex sentence is.
Image alternative texts are present transcripts of video content are provided and links contain text.
And simple and consistent layout, descriptive buttons clickable elements are put in context. No bright colours, good colour contrasts. Keyboard only uses supported. All information is published not buried in downloads. Clickable elements are given space. There’s no timeout windows.
So what I did in looking at the different entries and assessing them was firstly user web Accessibility tool called Wave to see if that brought up any errors or any warnings and that provides guidance and general Accessibility warnings, contrast errors, features also checked if the sites were mobile friendly.
By looking at them by resizing the browser window.
And then looking at the text how clear it was.
Checking whether there was a concept first approach checking if it could be used by keyboard, the standard.
Was very good. There was one or two which wants the handsome issues, but the rest were really on the button.
Another category was best design.
It’s raining and I’ll just start walking. Portals that found the perfect harmony of usability, content and aesthetics.
These developer portals present every aspect of the API and well structured, logical way. Developer portals that inspire trust through superior production quality.
And innovation, inspirational and motivational content tools for user engagement, for example, paperwork, innovative testing, supporting several learning approaches, API Explorer, visuals, and anything that surprises you as a juror in a positive way.
Innovative way to present their business models, they managed to increase the API’s perceived value through appropriate and clear.
So what their API’s are about and how they work? How developers can start integrating and where they can find resources. The evaluation criteria for that category is visuals that show the API architecture clear on boarding process, what’s needed to actually get started step by step tutorials.
Video tutorials, case studies, use cases, and access ability of try out.
Let me move on to somewhere little bit dryer.
And another category is best developer dashboard. The criteria for that one is Def portals that take specific care of logged in developer user journey. These portals provided dashboard that enhances the developer experience. For example with metrics transparent pricing, an overview of API keys and then the final category that I’ll talk about is best Community, Spotlight and.
Outreach, and that’s the one of the categories that I’ve been asked to judge. This category is about to death portals with creative solutions or initiatives to show developers that their work is appreciated. Portals with great community sections where developers can share knowledge and build connections. Some evaluation criteria that we’ve.
Being given or I’ve been given this guidance for this to consider blogs, events, community pages, links to third party communities and forums.
So how do you judge whether or community?
Is successful, this was quite a challenge to assess because you had small companies.
Where there was a great deal of information, support and engagement and blogging and videos and the like. But it was pretty much one way. It was a monologue because they didn’t have a large user base at this stage. There wasn’t much in terms of content from.
The actual users themselves, the customers, and then you had other very large companies that have been around for decades with lots and lots of API’s.
And there were lots of user engagements, but there was this challenge of complexity and.
And dealing with legacy content so.
This one was quite a challenge to actually assess as to how do you judge between quite different types of companies with different challenges that are there.
Those are the different categories the event is on from 4:00 o’clock GMT or UTC time till 6:00 o’clock.
Ending with a virtual champagne session, part of the event will be to interview the jury and to ask questions. And we’ve been forewarned on what some of the questions are likely to be, those being which category was the most challenging for you?
And as I said, it’s really community ’cause it is quite hard to assess the different types of organisations.
And the challenges they face. What aspects did you take into account when reviewing your categories?
And that is about really those that have to do with legacy.
And those that have the advantage of starting from scratch.
We’ll talk a bit more and reflect on that after a little white Scottie Dog.
The very muddy belly just passed.
What did you learn during your review? What did I learn? Well, one thing that stood out was the high quality of so many of the entrance. There’s a lot of time and money.
And thought going into creating some very high quality, very good API developer portals at the moment.
And did I encounter any surprising or exciting solutions? Yes, to an extent. I’ll talk about that at the event on that date.
So we will include a link to the event.
In the show notes, if you want to attend.
And watch the event.
And to get an opportunity to see all the different entrance and view the winner and so on.
I hope it’s good event and maybe we’ll see each other online over the web cams.
Just to finish up a little bit of news about Charlie. If we’ve introduced 2 new courses, we’ve struggled to workout the best way of describing how we deliver them and come up with virtual classroom as being the way that’s essentially meaning. There’s a trainer on Zoom or teams and.
Delegates on zoom in teams and we run the class in a very similar way too, as if everyone was in a physical classroom. So we call it a virtual classroom. The two courses we’ve introduced, one is a technical writing course for support staff, so the people who are doing support tickets and the like and get involved with writing, troubleshooting guides and online help and on boarding.
Helping them with the fundamentals of writing.
And efficiently and effectively.
The other course is a policies and procedures for promoting course for financial procedures. We’ve been involved with some projects.
Recently that involved financial related procedures, management accounting or statutory accounting procedures or budgeting and financial control type procedures within organisations.
And so for those people that are involved.
In writing, those and want some guidance.
So people like accountancy, no.
Accountancy side but don’t have really much training in how to write clearly. Then we’ve got a course now.
A virtual classroom course for them and that’s on the Cherryleaf website.
Cherryleaf.com under the training section.
At that’s it’s the rain stopped.
And walk back towards the entrance.
Before I came onto the tow path. Thank you for listening. If you want to contact us email@example.com you’re more than welcome to give us a rating on the podcast platforms such as iTunes that helps enormously.
Apart from that, thank you for listening until next time.