API tech writing workshop comes to New York City

On Monday, September 21st, I’m hosting a full-day workshop in New York City, on API technical writing. It’s free, and you’re invited. There’s free food too!

The workshop is happening in collaboration with the New York Metro Chapter of the STC (Society for Technical Communication). Anyone interested in learning about this role is welcome to attend – you don’t need to be a member of the STC.

Quick signup link: Register to attend the workshop on the STC New York Metro website.

What is API technical writing?

API stands for Application Programming Interface. Developers use APIs to make apps that communicate with other apps and 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 tech writer, it’s an exciting, challenging and rewarding field. I love it!

This workshop gives you hands-on experience with APIs and API documentation, insight into the demands of the role, and plenty of information for your own follow-up study.

Workshop details

Date: Monday, September 21st, 2015
Time: 9am to 4pm – breakfast and setup are at 9am, for a start at 9:30 sharp
Instructor: Sarah Maddox  – that’s me 😉
Cost: None. The workshop is given free of charge.
Location: The Google offices in New York city: 76 Ninth Avenue, New York, NY 10011. (Link on Google Maps.) Enter through the tenant entrance at the corner of 16th St and 9th Ave, and report to the workshop registration table. (It will have Google-branded linen.)

This is a practical course on API technical writing, consisting of lectures interspersed with hands-on sessions where you’ll apply what you’ve learned. The focus is on APIs themselves as well as on documentation, since we need to be able to understand and use a product before we can document it.

The workshop includes the following sessions:

  • Lecture: Introduction to APIs, including a demo of some REST and JavaScript APIs.
  • Hands-on: Play with a REST API.
  • Lecture: JavaScript essentials.
  • Hands-on: Play with a JavaScript API.
  • Lecture: The components of API documentation and other developer aids.
  • Hands-on: Generate reference documentation using Javadoc.
  • Lecture: Beyond Javadoc – other doc generation tools.
  • Lecture: Working with an engineering team

Preparation for the workshop

Please take a look at the event announcement to see what you need to install on your laptop before the workshop. Doing the recommended installations will save you a lot of time at the workshop so that you can avoid missing crucial bits when you’re there.

Hope to see you there!

Here’s that signup link on STC New York Metro site.

I’m looking forward to meeting a number of New York technical writers!


A slide from the workshop

About Sarah Maddox

Technical writer, author and blogger in Sydney

Posted on 10 August 2015, in technical writing, workshops. Bookmark the permalink. 13 Comments.

  1. Hi Sarah,
    This is great news! Will this be recorded for people who are remote?

    • Hallo Lavanya, we don’t plan to record the workshop. I’ll be running it soon in Seattle – is that anywhere near you? Alternatively, we hope to run it in California again soon.

  2. Hi Sarah,

    This is so awesome! It would have been great if you could record this.
    I am hoping there’ll be a post on your blog about it.

  3. Lisa_Scheuplein@DellTeam.com

    Dell – Internal Use – Confidential
    Any chance you will bring this to the Austin Google office?


    • Hallo Lisa
      There aren’t any plans yet to do the workshop in Austin, but I’ve added it to the list of locations for future consideration. I’d love to come and meet the Austin writers sometime!

  4. Sarah,

    This is great! I am very interested in learning more about API documentation.

    I signed up through the STC NY Metro site. I did not receive a confirmation email and I know there is limited seating. Do you know if we will be notified if we made the cut?

    Thank you for any assistance you can provide.


    • Hallo Jeff
      It will be great to see you at the workshop. I don’t know how many people have registered to date. The maximum number of attendees is 50. I’ve forwarded your enquiry to my contact at the STC New York Metro, and either they or I will reply here.

  5. Hi, Jeff. I am the president of STC NY Metro. You are in! We will send confirmations 24 hours before the event. To date, we have 30 registrants.

    • Julie,

      Thank you for the quick reply. I will be traveling to make the event and need to get company approval, book a hotel, etc… I appreciate you letting me know I’m in.


  6. Sarah,

    Will the upcoming Seattle workshop be offered as a virtual workshop? Can one purchase workshop recordings? I’m writing about APIs and love to gather new information.

    Any plans on coming to the Boston area?

    Bobbi Hennessey

    • Hallo Bobbi
      Unfortunately the workshop isn’t available in virtual or recorded format. It’s quite interactive, which makes those formats impractical. I’d love to prepare material for a recorded version, but I don’t have the bandwidth at the moment. I’ll add Boston to the list of requested locations, but we haven’t scheduled a workshop there at this point. Thanks so much for letting me know you’re interested! Do you have any idea how many other people in the Boston area may want to attend?

  7. Hi Sarah,

    I tried to contact you via a Google+ PM about Tech Comm Map. But since I am new to Google+ maybe I did something wrong. Sorry for disturbing here. Please have a look.


Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: