We often hear of API docs and how to create them, but it's often a mystery as to what they are, how we use them, and what needs to be there. Join Paul Perrotta, The Technical Documentation Wrangler, and Steve Sarette, a manager of Technical Documentation Automation at Palo Alto Networks, who is primarily responsible for Cortex REST API documentation there, as they discuss API docs and how to get started.
In this discussion, we'll talk about the following points:
1) What API docs are and why they're important
2) The major parts of an API doc set and their priorities
3) Writing to the cultural expectation of your audience (driven by the language(s) you're covering)
4) How you can learn to do API docs
This discussion is free to you and requires only a free BrightTalk login, a little time, and your own curiosity.
"Let's Talk Technical Documentation" is brought to you by The Content Wrangler.