Developer Experience
Right
Building The
Let The Force Of Be With You
Nabayan Roy
APIs
@nabayanroy #stc16
The Rise of Web
APIs
What is
Developer
Experience?
What are the
Key Elements of
Developer
Experience?
Real
Examples
The next 45 minutes…
@nabayanroy #stc16
The rise of the ‘Cloud’
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
API
API
API
Everything is an API, today
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Your API is a product.
Make it first class.
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Developers are users too
Are you building the developer experience right?
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
User Experience Developer Experience
“User experience refers to a
person's emotions and
attitudes
about using a particular
product, system or service.”
- Wikipedia
1. “User experience applied
to developers.”
2. “It is the sum of all interactions
between the developer and an
API.”
- Anonymous
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Key elements of the developer onboarding experience
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Understand your developers
Empathy principle
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Tailoring the first impressions
@nabayanroy #stc16Building The Developer Experience Right
Your homepage should invite developers
to stay, explore, or take action
@nabayanroy #stc16@nabayanroy #stc16Building The Developer Experience Right
Empowering developers
Developer Your API
Awesome & powerful developer
@nabayanroy #stc16
Selling the dream
@nabayanroy #stc16Building The Developer Experience Right
provide valuable context to developers so they
can better understand how your API works
@nabayanroy #stc16
Simple and instant signup
Keep the requirements light and the
process fast
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Outstanding documentation
Good documentation is vital; helps the
decision-making process
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Support every step in the path from novice to expert
Learning path trajectory
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Libraries and SDKs
Provide a working sample app that actually
shows developers best practices
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Evangelize and build a community
@nabayanroy #stc16Building The Developer Experience Right
Forge partnership
@nabayanroy #stc16
How we are building it: Forge and AutoCAD I/O
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16@nabayanroy #stc16Building The Developer Experience Right
The Mothership
@nabayanroy #stc16
Overview page
Building The Developer Experience Right
Limits and Quotas
Field Guide
API Basics
Recent Changes
AutoCAD I/O web service, which are design automation APIs on the Forge Platform, allows developers to run AutoCAD
scripts remotely and enable them to process DWG files at cloud scale. You can create an AutoCAD script or use one of
our sample scripts, then point the AutoCAD I/O web service to the DWG files, and finally run your script on the DWG
files. AutoCAD I/O loads the DWG files, and then runs the script on each file. Upon completion, AutoCAD I/O saves the
output to your specified location
Keep it crisp and clear
@nabayanroy #stc16
@nabayanroy #stc16@nabayanroy #stc16Building The Developer Experience Right
Recent Changes and Versions
Field Guide
API Basics
Limits and Quotas
What to include inside your overview section?
@nabayanroy #stc16@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Step-by-step guide
Building The Developer Experience Right
@nabayanroy #stc16
Interactive docs
Lets you easily explore the API endpoints
Building The Developer Experience Right
@nabayanroy #stc16
Explore further…
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Organize your APIs using endpoints in a logical manner
Error codes for your response and body structure
Request header, query parameters, and body structure
Resource information
An example (request-response pair)
API Reference must include
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Client libraries
Sample code
Building The Developer Experience Right
@nabayanroy #stc16
Forums
Blogs
@nabayanroy #stc16
Delighting your developers
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Show them how other developers are using your APIs
Case studies
Building The Developer Experience Right
@nabayanroy #stc16
Parting Thoughts
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
Photo credit: Edgaras Maselskis
Define, measure and
constantly improve
your ‘Hello World’
metrics.
Design APIs for people
and not machines— API-
first is one way to focus on
the developer experience
from the ground up.
Understand who
your developers
are and how to
address them.
Make sure that your
onboarding process is
as painless for
developers as
possible to lower the
barrier of entry.
Support your
developers, help build
the ecosystem and
contribute to the
community—keep
fueling the innovation
funnel
Building The Developer Experience Right
Keep factoring
your developers’
needs into your
API design
@nabayanroy #stc16
The rise of the API economy
@nabayanroy #stc16Building The Developer Experience Right
@nabayanroy #stc16
References, Resources, and Credits
• Don’t Make MeThink by Steve Krug
• The Elements of User Onboarding by Samuel Hulick
• Developer Evangelist Handbook written by Mozilla Developer Evangelist
Chris Heilmann
• 100Things Every Designer Needs to Know About People by Susan
Weinschenk
• Autodesk Forge Platform
• Nordic APIs
• API EvangelistWebsite. Author Kin Lane
• The theme is inspired by one of my most favorite movies of all time –
StarWars (and George Lucas)
Building The Developer Experience Right
@nabayanroy #stc16@nabayanroy #stc16Building The Developer Experience Right
<Nabayan Roy>
<Principal Learning Experience Designer>
<Autodesk>
<Practice Group="Experience Design"
Product="AutoCAD" Location="Singapore"
Email=“nabayan.roy@autodesk.com">
</ Practice Group>
</Autodesk>
</ Principal Learning Experience Designer>
</Nabayan Roy>
@nabayanroyTwitter Handle
LinkedIn Nabayan Roy
© 2016 Autodesk. All rights reserved.
Autodesk and the Autodesk logo are registered trademarks or trademarks of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and/or other countries.
All other brand names, product names, or trademarks belong to their respective holders. Autodesk reserves the right to alter product and services offerings, and
specifications and pricing at any time without notice, and is not responsible for typographical or graphical errors that may appear in this document.

Building the Developer Experience Right - May The Force of API Be With You

  • 1.
    Developer Experience Right Building The LetThe Force Of Be With You Nabayan Roy APIs
  • 2.
    @nabayanroy #stc16 The Riseof Web APIs What is Developer Experience? What are the Key Elements of Developer Experience? Real Examples The next 45 minutes…
  • 3.
    @nabayanroy #stc16 The riseof the ‘Cloud’ @nabayanroy #stc16Building The Developer Experience Right
  • 4.
    @nabayanroy #stc16 API API API Everything isan API, today @nabayanroy #stc16Building The Developer Experience Right
  • 5.
    @nabayanroy #stc16 Your APIis a product. Make it first class. @nabayanroy #stc16Building The Developer Experience Right
  • 6.
    @nabayanroy #stc16 Developers areusers too Are you building the developer experience right? @nabayanroy #stc16Building The Developer Experience Right
  • 7.
    @nabayanroy #stc16 User ExperienceDeveloper Experience “User experience refers to a person's emotions and attitudes about using a particular product, system or service.” - Wikipedia 1. “User experience applied to developers.” 2. “It is the sum of all interactions between the developer and an API.” - Anonymous @nabayanroy #stc16Building The Developer Experience Right
  • 8.
    @nabayanroy #stc16 Key elementsof the developer onboarding experience @nabayanroy #stc16Building The Developer Experience Right
  • 9.
    @nabayanroy #stc16 Understand yourdevelopers Empathy principle @nabayanroy #stc16Building The Developer Experience Right
  • 10.
    @nabayanroy #stc16 Tailoring thefirst impressions @nabayanroy #stc16Building The Developer Experience Right Your homepage should invite developers to stay, explore, or take action
  • 11.
    @nabayanroy #stc16@nabayanroy #stc16BuildingThe Developer Experience Right Empowering developers Developer Your API Awesome & powerful developer
  • 12.
    @nabayanroy #stc16 Selling thedream @nabayanroy #stc16Building The Developer Experience Right provide valuable context to developers so they can better understand how your API works
  • 13.
    @nabayanroy #stc16 Simple andinstant signup Keep the requirements light and the process fast @nabayanroy #stc16Building The Developer Experience Right
  • 14.
    @nabayanroy #stc16 Outstanding documentation Gooddocumentation is vital; helps the decision-making process @nabayanroy #stc16Building The Developer Experience Right
  • 15.
    @nabayanroy #stc16 Support everystep in the path from novice to expert Learning path trajectory @nabayanroy #stc16Building The Developer Experience Right
  • 16.
    @nabayanroy #stc16 Libraries andSDKs Provide a working sample app that actually shows developers best practices @nabayanroy #stc16Building The Developer Experience Right
  • 17.
    @nabayanroy #stc16 Evangelize andbuild a community @nabayanroy #stc16Building The Developer Experience Right Forge partnership
  • 18.
    @nabayanroy #stc16 How weare building it: Forge and AutoCAD I/O @nabayanroy #stc16Building The Developer Experience Right
  • 19.
    @nabayanroy #stc16@nabayanroy #stc16BuildingThe Developer Experience Right The Mothership
  • 20.
    @nabayanroy #stc16 Overview page BuildingThe Developer Experience Right Limits and Quotas Field Guide API Basics Recent Changes AutoCAD I/O web service, which are design automation APIs on the Forge Platform, allows developers to run AutoCAD scripts remotely and enable them to process DWG files at cloud scale. You can create an AutoCAD script or use one of our sample scripts, then point the AutoCAD I/O web service to the DWG files, and finally run your script on the DWG files. AutoCAD I/O loads the DWG files, and then runs the script on each file. Upon completion, AutoCAD I/O saves the output to your specified location Keep it crisp and clear @nabayanroy #stc16
  • 21.
    @nabayanroy #stc16@nabayanroy #stc16BuildingThe Developer Experience Right Recent Changes and Versions Field Guide API Basics Limits and Quotas What to include inside your overview section?
  • 22.
    @nabayanroy #stc16@nabayanroy #stc16BuildingThe Developer Experience Right
  • 23.
    @nabayanroy #stc16 Step-by-step guide BuildingThe Developer Experience Right
  • 24.
    @nabayanroy #stc16 Interactive docs Letsyou easily explore the API endpoints Building The Developer Experience Right
  • 25.
    @nabayanroy #stc16 Explore further… @nabayanroy#stc16Building The Developer Experience Right
  • 26.
    @nabayanroy #stc16 Organize yourAPIs using endpoints in a logical manner Error codes for your response and body structure Request header, query parameters, and body structure Resource information An example (request-response pair) API Reference must include @nabayanroy #stc16Building The Developer Experience Right
  • 27.
    @nabayanroy #stc16 Client libraries Samplecode Building The Developer Experience Right
  • 28.
  • 29.
    @nabayanroy #stc16 Delighting yourdevelopers @nabayanroy #stc16Building The Developer Experience Right
  • 30.
    @nabayanroy #stc16 Show themhow other developers are using your APIs Case studies Building The Developer Experience Right
  • 31.
    @nabayanroy #stc16 Parting Thoughts @nabayanroy#stc16Building The Developer Experience Right
  • 32.
    @nabayanroy #stc16 Photo credit:Edgaras Maselskis Define, measure and constantly improve your ‘Hello World’ metrics. Design APIs for people and not machines— API- first is one way to focus on the developer experience from the ground up. Understand who your developers are and how to address them. Make sure that your onboarding process is as painless for developers as possible to lower the barrier of entry. Support your developers, help build the ecosystem and contribute to the community—keep fueling the innovation funnel Building The Developer Experience Right Keep factoring your developers’ needs into your API design
  • 33.
    @nabayanroy #stc16 The riseof the API economy @nabayanroy #stc16Building The Developer Experience Right
  • 34.
    @nabayanroy #stc16 References, Resources,and Credits • Don’t Make MeThink by Steve Krug • The Elements of User Onboarding by Samuel Hulick • Developer Evangelist Handbook written by Mozilla Developer Evangelist Chris Heilmann • 100Things Every Designer Needs to Know About People by Susan Weinschenk • Autodesk Forge Platform • Nordic APIs • API EvangelistWebsite. Author Kin Lane • The theme is inspired by one of my most favorite movies of all time – StarWars (and George Lucas) Building The Developer Experience Right
  • 35.
    @nabayanroy #stc16@nabayanroy #stc16BuildingThe Developer Experience Right <Nabayan Roy> <Principal Learning Experience Designer> <Autodesk> <Practice Group="Experience Design" Product="AutoCAD" Location="Singapore" Email=“[email protected]"> </ Practice Group> </Autodesk> </ Principal Learning Experience Designer> </Nabayan Roy> @nabayanroyTwitter Handle LinkedIn Nabayan Roy
  • 36.
    © 2016 Autodesk.All rights reserved. Autodesk and the Autodesk logo are registered trademarks or trademarks of Autodesk, Inc., and/or its subsidiaries and/or affiliates in the USA and/or other countries. All other brand names, product names, or trademarks belong to their respective holders. Autodesk reserves the right to alter product and services offerings, and specifications and pricing at any time without notice, and is not responsible for typographical or graphical errors that may appear in this document.