Our Writing API Documentation course runs April 8

Post 7 of 219
Our Writing API Documentation course runs April 8

Our second hands-on training course of the year, Writing API Documentation, will run at BCIT’s downtown campus at 555 Seymour Street on Saturday, April 8.

This course is designed for technical writers who have never done API documentation before.

The ability to write API documentation is a very useful skill to add to your repertoire as a tech writer, and hands-on courses teaching it are few and far between in the Lower Mainland.

The course will run from 9 am to 4:30, with a break for lunch. The cost is $100 for STC members, and $250 for non members, and includes a completion certificate.

By the end of this class, you should be able to:

  • Use, create, and edit interactive API documentation.
  • Understand the differences between interactive and non-interactive API documentation.
  • Understand how interactive and non-interactive API documentation work together effectively.
  • Create an interactive API documentation system using Open Source technologies.

The course instructor will be Marc Bell, a tech writer and programmer at SAP, where he’s responsible for all developer-focused API documentation, tutorials, and sample code for SAP Jam Collaboration and Communities.

Marc recently presented the seminar, “How Great API Documentation Inspires Developers”, at SAP DKOM Vancouver.

You’ll be working at a training lab computer, but you also have the option to bring your own laptop and use BCIT’s wifi connection. You’ll be downloading and installing Swagger, the most popular API documentation application used today. It’s Open Source and free.

REGISTRATION FOR THIS COURSE IS NOW CLOSED.

This article was written by Stephen Gauer

Stephen is a senior technical writer with more than 20 years experience writing for corporate and hi-tech clients in Vancouver and Toronto. He is the president of the STC Canada West Coast chapter.

Menu