One of the more challenging aspects of working with APIs is that outside of your own little tech bubble, nobody actually knows what an API is - despite being hopelessly dependent on APIs for their day to day lives. So how do you talk about APIs to the masses of people who have no idea what they are? You're going to have to do it - you'll need to talk to your non-technical colleagues about it, many of whom you're entirely dependent upon to improve your API or get it out to the masses; there'll be potential customers out there for whom your API is the exact solution to the problem they're having and there's the people you meet who ask you what it is you do.
In this talk we'll discuss how overcome this huge challenge for all of us in the business of APIs, how to establish not just a clear ubiquitous language when talking about our APIs but clarity and consistency of content - making sure your developers, salespeople, support and marketing are all talking about your APIs in a way that is accessible, meaningful and useful to all concerned, and how that consistency of understanding can be the difference between the success or failure of your API.
1. How to Talk about APIs
Andrew Seward
Head of Product at Cronofy
@MrAndrew
2. WE WILL COVER
• Why APIs are hard to talk about
• Why this is a problem
• Tips for talking about APIs
• The importance of establishing an
accessible ubiquitous language
@MrAndrew
16. @MrAndrew
EXPLAINING YOUR API
Overview / Elevator Pitch
Use case Use case Use case Use case
It’s an API
Easy to
useSecure
Well
documented RESTful
Authentication Endpoints
Requests /
Responses
Errors
Technical Implementation
Detail
The Product
Differentiating
features
Basic features
Instructions
Nobody cares
17. GIVE A PRODUCT OVERVIEW
…..…. allows …………..…
to ………………
<Product> <target customers>
<business activity>
@MrAndrew
18. GIVE A PRODUCT OVERVIEW
…..…. allows …………..…
to ………..………………
Cronofy software providers
connect to their users’ calendars
@MrAndrew
19. DESCRIBE KEY FEATURES WITH EXAMPLES
…for example, ………..
uses ………………………..
to ……………………….
<API or feature>
<Achieve real-world outcome>
<existing customer>
@MrAndrew
20. DESCRIBE KEY FEATURES WITH EXAMPLES
…for example, ………..
uses ………………………..
to ……………………….
The Oxford University Press Dictionary AP
Show word definitions on Kindle
Amazon
@MrAndrew
22. THE LANGUAGE WE USE
• Governs how we think about our APIs
• Establishes the shared understanding within the organisation
• Keeps all the output of the company consistent with the product
• Keeps development rooted in real world customers and use cases
• Makes it easier to work together
@MrAndrew
23. WE COVERED
• Why APIs are hard to talk about
• Why this is a problem
• Tips for talking about APIs
• The importance of establishing an
accessible ubiquitous language
@MrAndrew
Notas do Editor
someone at a dinner table ask about what I do
I used to not bother explaining but then I became a product manager and it was my problem
I also keep bees, my parents ask me about my job and about my bees
but both have similar complexity problems
1 minute
Technical people think of them as a way to have one system to talk to another
This is not wrong but overly simplistic
Talk about Esendex example
What we’re going to talk about is how to fill in those gaps
pick on someone
You can’t see, touch or even reasonably try out an API
so how do we do
Giuliano just touched on this
Articulating your technical product in a way that is accessible to them is essential to their success and therefore your API’s success
Not going to say “THIS IS HOW YOU TALK ABOUT APIs” despite that being my premise
not how it works or is consumed
Kit Kat is a complex product more than your API - but they don’t talk about
Not “basic features” in the sense that they’re easy to implement
Social proof
Tells you how that feature works
This is just as useful for technical people as non-technical people
Social proof
Tells you how that feature works
This is just as useful for technical people as non-technical people