Plan Your API Documentation By Understanding the Audience, Market, and Product


Dr. Bob Watson
PhD, Assistant Professor, Technical Communication, Mercer University


December 14, 2016 - 2:00 PM


December 14, 2016 - 3:00 PM

Plan your API Documentation by Understanding the Audience, Market, and Product

Objective: to describe the factors that influence an API documentation content strategy for technical writers who are new to API documentation planning and writing. The webinar reviews the aspects of the audience, market, and product on which technical writers should focus to create an effective content strategy for API documentation.

The framework presented in the webinar describes areas the aspects of the audience, market, and product (the API) that influence the documentation priorities of an API content strategy. Each of these aspects has many factors to consider, but not all factors influence your API content strategy equally and their influence depends on the specific situation. The webinar reviews how to evaluate the factors of each aspect to define the API documentation priorities for your unique situation.

Takeaways: After attending this webinar, you will have a better understanding of how to determine what is important for your API, your market, and your customers. You will also have the tools to apply that understanding and create a more effective API content strategy.