Session

Developer Experience: Strategies to Create Great API Knowledge

Good documentation sells APIs. Content is king and it will make your API site successful. In this presentation, I describe how to design and create richly meaningful API documentation.

In recent surveys, developers rated the types of information they want. On a scale of 1-4, a majority rated complete and accurate documentation at 3.5+. In another survey, developers rated overviews and conceptual information as important as API references and code samples.

Using the design and writing principles I provide, you will be able to architect information that API developers say they want. I review the evolution of various types of API documentation sites that our team created over the last decade.

Based on our lessons learned, I provide simple tips and an API site template that small teams can use to develop meaningful documentation.

Charles Miller

Lead Content Strategist (API), Medidata Solutions, a Dassault Systemes company

Albuquerque, New Mexico, United States

Actions

Please note that Sessionize is not responsible for the accuracy or validity of the data provided by speakers. If you suspect this profile to be fake or spam, please let us know.

Jump to top