I am writing this article based on the short talk I gave at DevRel Summit in Seattle, and it is aimed for my fellow developer advocates, platform engineers, product managers, and CTOs, who work for companies that provide developer platforms, APIs etc. also anybody who advocate their own software / libraries / frameworks.
When your potential developers, who are in search for a solution for a new project- this can be a large-scale commercial project, or it could be to compete at a hackathon, see your shiny website but has very poorly-designed developer portal (or your open-source project on GitHub may have some stars, but with no README), how does the developer feel? Do they still want to try it out anyway, or keep searching something else and end up choosing your competitor?
I have been working as a developer evangelist, or related positions in Developer Relations for about six years for three (technically four, including acquisition) different companies, to advocate both proprietary and open technologies. From the experiences, what I’ve seen is that developers (including myself) tend to shy away when the API (or platform, services, etc.) is poorly designed, lacks good docs, Get Started guide, or code samples.
This Developer Experience is one of the biggest key factors for developers to decide if they use certain technologies to use.
User Experience and Developer Experience
Before becoming a developer evangelist, I was working as a developer in the Human Interface team for Palm webOS mobile platform. Although we didn’t successfully dominate the market, what the team has designed has been inherited to present-era iOS and Android. For example, non-intrusive visual notification system, card views, universal search bar, etc.
My then-teammates has influenced me so much, and it has affected my career and my way of thinking. Since then, I care usability and user-experiences (UX) for everything — not only software and hardware interface designs, but for coding styles, APIs, and documentation, because I believe UX is also applied to developers when your users are developers.
According to usabilty.gov,
User-Experience (UX) focuses on having a deep understanding of users, what they need, what they value, their abilities, and also their limitations.
and I think the statement is still true when you swap out the word, user to developer:
Developer-Experience (DX) focuses on having a deep understanding of developers, what they need, what they value, their abilities, and also their limitations.
Yes, I am suggesting Developer Experience is a type of User Experience!
Bad Developer Experience and Frustrations
This is a good example of how not to design- At a gas station, you’ve got a gas pump looks like this, how do you react?
Typically, when a user faces such bad user experience, the reactions would be:
- Get confused
- Make a good guess and fail
- Repeat 2–3
- Totally pissed off
How about if you provide very enigmatic API, sans proper documentation or tutorial, and a developer is trying to figure out how to use the API- How does the developer react?
I think the reactions would be the same as above! The difference is that if you are at a gas station, you are more likely to try again or ask somebody to get your car filled up, while developers are more likely to google around (or ask Twitter followers) then ditch your service for use your competitor’s over the bad developer experiences.
So, what kinds of products have users who are developers? I tried to come up with a list of “products” that we need to care about developer experience-
- SDKs & tools
- Developer website UI/UX, and contents
- Docs, tutorials, and “Get started” guides
- Samples on GitHub — code & README
While developer evangelists have works including developer training including workshops and conferences, and events like hackathons, here, I only try to define products and excluding all the direct actions and interactions with developers.
API providers do also need to provide SDKs for common / high-demand languages, and sometimes for frameworks. You are losing developers when either SDK or API, as user-interface for developers, is missing.
Also, good API should be intuitive and easy to use, and bad API includes bad naming conventions, bad error messages, inconsistencies, etc. In his talk, Joshua Bloch stated that:
- API can be among a company’s greatest assets
- Can also be among company’s greatest liabilities
- Public APIs are forever
He also tells us to document religiously- good API must have good design and documentation. I am not going to summarize all his talks here, so I recommend you should watch the video by yourself.
When we are talking about API docs, actually we need to provide more than just API references. Developers expect:
- Reference documentation
- Getting Started guide
While API reference explains every call in the API and parameter, values, etc., other types of docs often provide step-by-step instructions, and copy-and-pasteable code samples, including Hello World.
A rule of thumb of writing these docs is keeping everything simple in plain English. Complex docs don’t impress your fellow engineers, but rather repel them. The basic tutorial should be short and simple too, but if you want to explore your creativity as I do, you should provide supplemental tutorials beyond your API docs- Blog, Demo, Showcase, etc.
Creative Contents for Developers
My expertise is providing interesting use cases with code samples and demos. (You can browse my articles on this blog and many other sites!) What I knew and what I’ve learned from my own experiences are that developer experience is good when a doc has these:
A picture is worth a thousand words — a simple diagram can explain a complex ideas far better. When I was writing about push notifications gateway for GCM and APNs, I decided to create a diagram to show how it works, rather than writing the whole explanations, and it turns out my readers (and coworkers) really did understand what the device registration meant, and how it works with push notification.
This is an actual screenshot of the blog I wrote for my previous employer, PubNub:
Step-by-step instruction in a bullet list helps your developers for sure, but I found they love when the steps are described with actual screenshots. And devs love even more when they are in a single gif animation, which I think is a great example of the TL;DR principal!
This example below is what I created to show how to use the Chrome DevTools Device Mode. I created for my own blog, and, later adopted by Google’s Chrome team, and stayed on the official doc for a while.
Especially, when you are targeting the first-timers, I found video tutorials are quite effective, because N00bs may have no idea where to get started. I don’t blame them because there is always a first time for everybody.
I created this Johnny-Five video because I was asked by enough numbers of people where to get started with hardware. The tutorial is targeting Node.js engineers who have no prior experiences with hardware engineering. I show electrical parts and explain what they are and how to wire. A cool thing is that the tutorial was introduced on Arduino official blog, and got a lot of good feedback on social media.
More Improvement for Better DX
There are more things I try to keep in mind for good DX-
- Publish date should be included, especially because a dev year is like a dog year, where things get outdated pretty quickly.
- No pushy marketing- obnoxious “Sign up now!!!” buttons and popups annoy devs away.
- Docs and tuts need to have good browsing experiences just like web pages. Always link to references and related pages.
- Don’t PDF everything. Docs and tuts for developers are not white papers.
- Provide a place for feedbacks. Provide an easy way to get connected with the support team if needed.
- Cut the BS- if your API is not ready or buggy, state so honestly.
I stumbled upon this tweet about user-friendliness on the other day-
It is interesting to see how the two companies describe the same errors in such different languages.
I was curious about how these companies differ in Developer Experience, so I took a look at their API docs, and the results were not surprising. I am pretty sure the product peeps (who worked on the messages) at JIRA and Slack don’t work for the API docs, however the friendliness of these docs reflect exactly like-
These are documentations for their OAuth authentication-
This is pretty clear that Slack docs are far more developer-friendly, not because of the cute robot, but the non-authoritative tone, and the way they introduce OAuth (what it is, and how it works) and the diagram, while JIRA doc doesn’t even bother explaining what OAuth is, as if newbie developers are not welcomed.
I wonder if it is more “appropriate” for enterprise companies to be unfriendly to both user and developer…
(Disclaimer: I wrote this article before I was employed by Slack in 2017).
Knowing Your Developers
If you interact directly with developers on chat or forum or work with community managers who do, you probably already have a good idea about your developer community.
Another method I adopted from the Human Interface team was defining persona during the product development process. In my case, of course, it is developer personas. I gather information from registrations, surveys, Stackoverflow, and support team (e.g. What language/SDK a developer use? What kinds of apps they develop?) Also, I get info from sales reps and business development team about an actual customer (e.g. size of a client’s company, industry, location, etc.)
I sometimes conduct brainstormings. This is quite effective to generate creative ideas and solutions, as well as team building. I combine the persona and brainstorming to figure out what our developers want.
This photo was taken right after the first brainstorming session was done at my previous work. After the session, we sorted the ideas in categories and feasibility.
Sure, this does not look like your typical Developer Relations meeting, but I have successfully delivered a lot of good use-cases and tutorials and articles around them. After social media has picked up, the awareness of the virtually unknown company and the products went up.
Diversity and Inclusiveness
The majority of developers may be male and understand English, but if you are targeting only the majority, you are still missing out on large numbers developers out there.
Inclusivity typically means not to exclude any groups of gender (expression), race, ethnicity, disability, sexual orientation, etc. I am not going to talk too much about the importance of diversity in a workplace in this article, however, I strongly believe when you work at a diverse team, you can definitely reach out more developers, especially because people, in general, tend to trust somebody who they feel related to. In fact, many of my “fans” are minorities- women, immigrants, speaking English as a second language, etc. (It is very flattering when people tell/tweet/email me they are fan of my works!)
Especially when somebody in your team speak/write something other than English, it would be a huge advantage. I do speak and write Japanese fluently, and on numerous occasions, I have helped sales and other teams when the companies have Japanese clients. I have written blog posts, and spoken at conferences in Tokyo as well. My conference videos and slides on Slideshare have reached out far larger audiences. I can clearly tell you that it’s not easy for you to get into Asian markets without somebody who knows the languages and cultures well!
Even if your team has no other multi-lingual people or simply has no time to translate, when your organization has successfully supported international developers, the community helps you.
For example, Dev.Opera publishes its tech blog under Creative Commons and open-sourced the contents on GitHub, where their community can contribute. I have written an article in English for Dev.Opera, and the community member has translated it in Russian! How awesome is it!
It is not easy to acquire fans worldwide, but having a diverse team makes it far easier.
Developer Experiences really matters!
Here’s the slide deck from DevRel Summit :
Originally published at www.girliemac.com on August 16, 2016.