apidays LIVE Paris 2021 - APIs and the Future of Software
December 7, 8 & 9, 2021
Test developer experience, not code
Kathrine Osadchenko, API Technical Writer & Content Developer at WIX.com
2. What I do as a Tech Writer
Medieval
timesā¦
Internal docs,
release notes
Dev Portal, Dev Guides,
eComm platform APIs
Financial services
and payments APIs
4. We know that APIs are complex.
Can we design developer experience?
ā Does this make sense to someone who uses the API for the ļ¬rst time?
ā What is the ļ¬rst crucial thing people are looking for and HOW do they search it?
ā Is there context or too much context?
ā Itās not just about internal logic and how things operate on your side when you
decide on the API structure and documentation layout.
Itās about that other personās perspective and compatibility on their side of
integration.
5. New York
JULY
Australia
SEPTEMBER
Singapore
APRIL
Helsinki & North
MARCH
Paris
DECEMBER
London
OCTOBER
Jakarta
FEBRUARY
Hong Kong
AUGUST
JUNE
India
MAY
Check out our API Conferences here
50+ events since 2012, 14 countries, 2,000+ speakers, 50,000+ attendees,
300k+ online community
Want to talk at one of our conferences?
Apply to speak here
6. Complexity by itself is neither good
nor bad: it is confusion that is bad.
How do we balance complexity and
simplicity in API design?
9. What makes API and supporting docs more usable
āŖ Who is your API consumer: their work environment/set up
āŖ Way of working and habits
āŖ Points of entry and use cases
āŖ Interactive and up to date Q&A. Document and cover repeated questions
āŖ SEO optimized content
āŖ Company/service speciļ¬c Stack Overļ¬ow/Answers
11. ā Distinguish what goes in details in internal API docs
unlike external as a product for 3rd parties
ā SME knowledge transfer and sharing
ā Deļ¬ne dependencies and cover them in details
ā Follow your structure
Internal APIs
API references
12. External API is a product, so are the API docs
Straightforward, to the point, short and sweet
Support (donāt distract) with visuals/diagrams
Gather and incorporate feedback on usability
External APIs as a product
API references
15. New York
JULY
Australia
SEPTEMBER
Singapore
APRIL
Helsinki & North
MARCH
Paris
DECEMBER
London
OCTOBER
Jakarta
FEBRUARY
Hong Kong
AUGUST
JUNE
India
MAY
Check out our API Conferences here
50+ events since 2012, 14 countries, 2,000+ speakers, 50,000+ attendees,
300k+ online community
Want to talk at one of our conferences?
Apply to speak here