On Monday, September 21, 2015, learn about API technical writing, apply what you've learned in hands-on sessions, and network with colleagues.
9:00 am - 9:30 am EDT (UTC -4) - Breakfast and setup
9:30 am - 4:00 pm EDT (UTC -4) - Workshop presentation with lunch and afternon refreshments
We will provide breakfast, lunch, and afternoon refreshments, free of charge.
API stands for Application Programming Interface. Software developers use APIs to make apps that communicate with other apps and with software/hardware components. API technical writers create documentation and other content that helps developers hook their apps up to someone else’s API. For a technical writer, it’s an exciting, challenging and rewarding field.
This is a practical workshop on API technical writing, consisting of lectures interspersed with hands-on sessions where participants will apply what they have learned. The focus is on APIs themselves as well as on documentation, since technical writers need to be able to understand and use a product before they can document it.
The workshop includes the following sessions:
For questions about the workshop content, contact Sarah Maddox on firstname.lastname@example.org.
Please install and configure the following software before the workshop (see Pre-workshop Software Installation & Configuration below):
This workshop assumes that you have some experience as a technical writer in the software industry, and are interested in moving into API documentation.
You’ll need a working knowledge of web pages and HTML. It will be useful if you have a basic understanding of programming. Recommended reading before the workshop is: