For a technical communicator, the task of documenting an API can be overwhelming. By having a defined methodology for documenting APIs, the technical communicator can bring order to chaos.

This presentation illustrates one such methodology for understanding the API documentation process and documentation deliverables. The presentation will provide a high-level overview of:

• Defining your audience, including requisite domain knowledge
• Understanding the place the API occupies in the company’s marketing strategy
• Planning the documentation deliverables
• Researching the API
• Preparing to interview the engineering SMEs (Subject Matter Experts)
• Effective interviewing techniques