•  

Your Documentation Is Your UX

A session at API Strategy and Practice Conference 2016

Thursday 3rd November, 2016

11:00am to 12:30pm (EST)

As APIs are becoming more widespread and used by an increasing number of people from non-technical backgrounds, documentation needs to evolve. When trying to use an API instead of consulting a long website with just paragraphs of text, documentation will need to be more tailored to the reader. How technical a user is, which technologies they are using to interact with an API, and how much they've used it in the past should all affect the documentation they are viewing. Being able to include API keys in code samples, adjust examples based on if a user is using Ruby, Node, etc. and showing relevant documentation after they encounter an error are all examples of how documentation can adapt to provide the most utility. Documentation is the user experience for the API, so it needs to be a first class citizen.

About the speaker

This person is speaking at this event.
Marc Cuva

Livin' Life So Trill @readmeio bio from Twitter

Sign in to add slides, notes or videos to this session

Tell your friends!

When

Time 11:00am12:30pm EST

Date Thu 3rd November 2016

Short URL

lanyrd.com/sffmqt

Official event site

boston2016.apistrat.com

View the schedule

Share

See something wrong?

Report an issue with this session