API Documentation Workshop

Date: Saturday, February 8, 2014
Time: 9:00 AM to 4:00 PM
Location: Nimble Storage, Inc., 211 River Oaks Parkway, San Jose CA 95134
Cost: $100 STC members, $125 non-members (includes lunch)
Sponsor: STC Silicon Valley Chapter
Instructor: Jim Bisso
Please bring: Your laptop

Workshop Description

One of the hottest markets for technical communication jobs in Silicon Valley is API documentation. Yet few tech comm books, conference sessions, or workshops tend to focus on developing API documentation skills.

One reason is that API documentation is typically seen as the developer’s domain, requiring a programmer’s level of knowledge to navigate. In reality, technical writers can create helpful API documentation without being full-fledged programmers.

With a working knowledge of the code you’re documenting, you can create API documentation that includes descriptions of objects, methods, arguments, as well as code samples and other details to help developers understand how to successfully use an API.

In this all-day workshop, Jim Bisso, a veteran of API documentation and author of Documenting APIs—Writing Developer Documentation for Java APIs and SDKs, will cover a variety of topics to help technical writers get started with API documentation. Specifically, the workshop will include the following:

  • What is an API?
  • What is API documentation?
  • What are the different kinds of API (developer) documentation?
  • Writing good API documentation.
  • Overview of tools and languages.
  • Samples of API docs.

Bring your laptop!

The workshop will be held at the following location:
Nimble Storage, Inc.
211 River Oaks Parkway
San Jose CA 95134

Nimble Storage offers plenty of free parking onsite. Meet in the lobby of the 211 building at 9:00 AM to sign in and be directed to the workshop classroom. Note that by company policy, all visitors must sign an NDA. Power outlets and Wifi are provided.

Lunch will be served from noon to 1:30 PM. We are ordering a variety of pizzas and salads. Please inform us of any dietary restrictions so we may better accommodate you.

Registration

The workshop is full!

We hope to have another API Documentation Workshop later in 2014.

Questions?

If you have any questions about the workshop, contact Tom Johnson (the event organizer) at tom@idratherbewriting.com or Jim Bisso (the instructor) at
jbisso@gmail.com.

About the Instructor

jim-bisso

Jim Bisso has 25 years of experience writing API documentation for such companies as Oracle, Sun Microsystems, Inprise, and Taligent. He has also taught computer science and documenting APIs at UC Berkeley Extension, Golden Gate University, Mills College, and the University of San Francisco. Jim has also been a corporate trainer for Oracle University and Bitzone LLC.