Learn about API technical writing in Washington DC

Are you a technical writer in or around Washington DC? On Friday March 20th, I’m running a full-day workshop on API technical writing. It’s free, and you’re very welcome to attend. There’s free food too!

The workshop is happening under the auspices of the STC Washington, DC – Baltimore Chapter. The content is the same as that of the workshop I ran in Mountain View in January, with a few updates based on feedback from participants.

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.

Workshop details

Date: Friday, March 20th, 2015
Time: 9 am to 4 pm
Cost: None. The workshop is given free of charge.
Location: Room: “The White Space”, 9th Floor, 25 Massachusetts Ave NW, Washington, DC 20001 (map: http://goo.gl/A4FqJ8). A parking garage is connected to the building. To see parking rates and hours, search for the address on the parking locator.

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.

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.

More details and signup

The event announcement by the STC Washington, DC – Baltimore Chapter has more details. To register for the workshop, scroll down to the Eventbrite box on that page, or go straight to the Eventbrite registration page.

I’m looking forward to meeting DC technical writers. Hope to see you there!

Screen Shot 2015-02-21 at 6.10.38 am

About Sarah Maddox

Technical writer, author and blogger in Sydney

Posted on 21 February 2015, in technical writing, workshops. Bookmark the permalink. 3 Comments.

  1. Sorry I missed this workshop. I heard it was great. Do you having upcoming sessions planned? How about an online version?

    • Hallo Joan

      I don’t have any upcoming sessions planned at the moment, but am open to suggestions.

      At the moment, the workbooks are only available to the people who attend the workshop, but I plan to make all the material (lectures/slides as well as workbooks) publicly available as soon as I have the time to convert them to a suitable format. Please stay tuned to this blog for updates.


  1. Pingback: Designing a workshop and workbooks | ffeathers

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: