REST API API Documentation Web APIs OpenAPI Swagger
Albuquerque, New Mexico, United States
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.
Published poet. Plays, movie script, and philosophical essay on Kierkegaard and Plato in dresser drawer.
Published article on Wittgenstein and dreams. Father to five beautiful children and grandfather to five. Survived the '70s, Disco, and Punk. Partied with Williams S. Burroughs and Allen Ginsberg. Successfully grew corn, tomatillos, and chiles in northern Minnesota.
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.
27 Oct 2020 - 29 Oct 2020
San Jose, California, United States