Category Archives: workshops

Invitation to a Tech Writing 101 workshop, Melbourne, November

Are you a software engineer wanting to learn the patterns of technical writing? Or a technical writer wanting to refresh the ABCs of our craft? Or someone who loves debating and exercising good writing styles? Join us for a Tech Writing 101 workshop in Melbourne, Australia, on Thursday, 15th November.

The workshop is part of the Write the Docs AU conference, and the cost of the workshop is included in the conference registration.

Quick reference

Workshop name: Tech Writing 101

Date & Time: Thursday, 15th November 2018, 2.30pm – 4.30pm

Location: Library at the Dock, 107 Victoria Harbour Promenade, Melbourne, Australia

Signup: Register for the Write the Docs AU conference

Prework and what to bring

Before attending the workshop, you need to do a small amount of pre-reading (about half an hour).

This is where you discover that tech writing patterns are interesting and fun.

On the day of the workshop, bring a laptop with a text editor and an internet (WiFi) connection to do the exercises.

Workshop overview

The workshop leads you through a series of exercises to improve the clarity, readability, and effectiveness of your writing. You’ll work in pairs, learning from an experienced Google technical writer (me) and from each other.

Topics include the importance of knowing your audience; what can go wrong when you use passive voice; how to avoid getting tangled up in long sentences and disorganised paragraphs; how lists have taken over the world.

By the end of the session you’ll also think differently about toothbrushes.

During the workshop, you’ll apply the principles you’ve read in the prework. We’ve found this method of learning is highly effective. And it’s just plain fun. The workshop has been run at SREcon in Europe 2017 and at SREcon in the US in 2018, where it was very well received. People said they came away with useful skills and cleaner teeth.

Who’s welcome

The intended audience for the workshop is people who’re interested in learning how to write efficiently and effectively. That includes software developers, support engineers, UX specialists, product managers, technical writers, editors – well, really, everyone who needs to write technical content.

I hope to see you there!

Instead of a picture of a toothbrush (as that’d be a spoiler) here are some patterns from a recent walk in the bush:

Two Australian tech writing conferences just around the corner

Are you in or near Australia in October and November? Then you’re in for a treat. We have two technical writing conferences in a row, within a stone’s throw of each other. Well, for some definition of “stone’s throw”, anyway. 😉

First up is the annual conference of the Australian Society for Technical Communication, which takes place in Surfers Paradise on 12-13 October. The conference theme is Let’s get technical, technical. Learn about CSS smart selectors, rethinking DITA, speeding up your web pages, blockchain, impossible docs, becoming an efficient writer, Simplified Technical English, and more. Follow up with a focused workshop on web coding. Check the list of presentations and fill in the registration form.

Next up is the Write the Docs AU conference in Melbourne on 15-16 November. This is the second WtD AU conference ever, following on from last year’s debut. This event offers a mix of presentations, lightning talks, workshops, and unconference sessions. Check out the schedule and get a ticket.

Found on a walk in the bush – patterns on the bottom of a squashed mushroom. Intriguing:

Inviting Seattle tech comm students to speed networking and workshop

The Puget Sound Chapter of the Society for Technical Communication (STC) is hosting a “speed networking” session at the University of Washington at 6pm on Tuesday, October 20th. I’m delighted to say that I’ll be there too. 

In addition, you’re invited to an API Technical Writing Workshop that I’m running in conjunction with the STC on Friday, October 23rd. It’s open to students as well as people already in the tech writing field. See the details here.

So, that’s 2 tech comm events in one week – an opportunity not to be missed. 🙂

Quick registration links:

Here’s the poster the STC shared with me, for the speed networking event:

Tech comm networking poster

 

Random remarks from me:

  • I like the spelling of “alumnae”. At first I thought, “Gah, typo!” Then I realised it’s a thing.
  • The purple colour is awesome. It matches my Ubuntu background!

I hope to meet many students and other Seattle tech comm folks at the networking event and at the workshop!

Seattle workshop on API Technical Writing

Will you be in Seattle on Friday, October 23rd? Join me and the Puget Sound Chapter of the STC for a full-day workshop on API technical writing. It’s free, and there’s free food too. 🙂 Join me and other Google tech writers in a day of API doc lectures and hands-on sessions.

Anyone interested in learning about API technical writing is welcome to attend – you don’t need to be a member of the STC.

Quick links: Register to attend, and learn more on the STC Puget Sound site.

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: Friday, October 23rd, 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: Google Offices, 601 N 34th Street, Seattle, WA 98103. (Link on Google Maps.)

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 prerequisites and setup 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.

Meet Google tech writers

There’ll be some Google tech writers at the workshop, assisting with any difficulties during the hands-on sessions. I’m hoping a couple of them will present some of the lectures too.

Hope to see you there!

Here’s that signup link on Eventbrite. I hope to see you there!

Slide from lecture – working with an engineering team:

Working with an Engineering Team

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!

workshop-slide

A slide from the workshop

%d bloggers like this: