How to Talk about APIs
Andrew Seward
Head of Product at Cronofy
@MrAndrew
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
APIs are hard to talk about
@MrAndrew
EXERCISE
Describe your API or
technical product
@MrAndrew
TECHNICAL PEOPLE THINK OF APIS LIKE
NON-TECHNICAL PEOPLE THINK OF APIS LIKE
Why are APIs hard to
explain?
@MrAndrew
DESCRIBE A CHOCOLATE BAR
@MrAndrew
DESCRIBE AN API
?
@MrAndrew
This is a big problem!
@MrAndrew
You need non-technical
people
Sales
Marketing
Accounting
Support
Legal Product Owners
Press
Customers
@MrAndrew
Tips for how to talk about APIs
@MrAndrew
BAD OPENING LINES
@MrAndrew
EXPLAINING YOUR API
Describe the real world
impact of using your
product
@MrAndrew
@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
GIVE A PRODUCT OVERVIEW
…..…. allows …………..…
to ………………
<Product> <target customers>
<business activity>
@MrAndrew
GIVE A PRODUCT OVERVIEW
…..…. allows …………..…
to ………..………………
Cronofy software providers
connect to their users’ calendars
@MrAndrew
DESCRIBE KEY FEATURES WITH EXAMPLES
…for example, ………..
uses ………………………..
to ……………………….
<API or feature>
<Achieve real-world outcome>
<existing customer>
@MrAndrew
DESCRIBE KEY FEATURES WITH EXAMPLES
…for example, ………..
uses ………………………..
to ……………………….
The Oxford University Press Dictionary AP
Show word definitions on Kindle
Amazon
@MrAndrew
Establish a ubiquitous language
that everyone can understand
@MrAndrew
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
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

How to Talk about APIs (APIDays Paris 2016)

  • 1.
    How to Talkabout 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
  • 3.
    APIs are hardto talk about @MrAndrew
  • 5.
    EXERCISE Describe your APIor technical product @MrAndrew
  • 6.
  • 7.
  • 8.
    Why are APIshard to explain? @MrAndrew
  • 9.
    DESCRIBE A CHOCOLATEBAR @MrAndrew
  • 10.
  • 11.
    This is abig problem! @MrAndrew
  • 12.
  • 13.
    Tips for howto talk about APIs @MrAndrew
  • 14.
  • 15.
    EXPLAINING YOUR API Describethe real world impact of using your product @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 PRODUCTOVERVIEW …..…. allows …………..… to ……………… <Product> <target customers> <business activity> @MrAndrew
  • 18.
    GIVE A PRODUCTOVERVIEW …..…. allows …………..… to ………..……………… Cronofy software providers connect to their users’ calendars @MrAndrew
  • 19.
    DESCRIBE KEY FEATURESWITH EXAMPLES …for example, ……….. uses ……………………….. to ………………………. <API or feature> <Achieve real-world outcome> <existing customer> @MrAndrew
  • 20.
    DESCRIBE KEY FEATURESWITH EXAMPLES …for example, ……….. uses ……………………….. to ………………………. The Oxford University Press Dictionary AP Show word definitions on Kindle Amazon @MrAndrew
  • 21.
    Establish a ubiquitouslanguage that everyone can understand @MrAndrew
  • 22.
    THE LANGUAGE WEUSE • 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 • WhyAPIs are hard to talk about • Why this is a problem • Tips for talking about APIs • The importance of establishing an accessible ubiquitous language @MrAndrew

Editor's Notes

  • #4 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
  • #5 I also keep bees, my parents ask me about my job and about my bees but both have similar complexity problems
  • #6 1 minute
  • #7 Technical people think of them as a way to have one system to talk to another This is not wrong but overly simplistic
  • #8 Talk about Esendex example What we’re going to talk about is how to fill in those gaps
  • #10 pick on someone
  • #11 You can’t see, touch or even reasonably try out an API so how do we do
  • #13 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
  • #14 Not going to say “THIS IS HOW YOU TALK ABOUT APIs” despite that being my premise
  • #16 not how it works or is consumed Kit Kat is a complex product more than your API - but they don’t talk about
  • #17 Not “basic features” in the sense that they’re easy to implement
  • #20 Social proof Tells you how that feature works This is just as useful for technical people as non-technical people
  • #21 Social proof Tells you how that feature works This is just as useful for technical people as non-technical people
  • #22 Internally and externally
  • #23 Accessible ubiquitous language