Charles Miller
Lead Content Strategist (API), Medidata Solutions, a Dassault Systemes company
Albuquerque, New Mexico, United States
Actions
Charles Miller creates end-user and API content for Medidata Solutions, a leader in online pharmaceutical trial management and trial planning software. Charles documents services and resources using OpenAPI and an in-house API document generation program that integrates with the Confluence content management system. He's seen API documentation evolve from manually written content to auto-generated content. He currently works on moving to the next stage in API content-delivery, including a full-service development central portal and information bots.
Currently working with development teams to document services and RESTful resources using OpenAPI and an in-house API document generation program that automatically integrates rendered content with Confluence knowledge spaces.
Winner of two national and international Society of Technical Communicators Distinguished writing awards for online help. One Honorable Mention.
Area of Expertise
Topics
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.
API World 2020 Sessionize Event
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