Christchurch Branch Event: Searching for a new skill? Try API docs!

You’ve probably heard about them, and you’ve definitely used them. APIs (application programming interfaces) are one of the main ways apps and widgets ask for information from a database or website. Developers love them – they write APIs and they know, in general, how APIs work. But how do developers know how to use someone else’s API? Well, that’s where technical writers come into the story.

Earlier this year I started work as a technical writer for a new set of APIs being developed in Christchurch. The company, SLI Systems, employs 85 people in Christchurch and another 40 overseas. We do search, and we do it really well!

In this presentation I’ll introduce you to JSON, stagger with Swagger, hang about in Stoplight, and show you what our API does. There’ll be plenty of acronyms (sorry about that), but I’ll try and introduce them to you gently.

Where and when

Streamliners, 4 Acton Street, Christchurch Central map

Tuesday 9 October. 5:30 pm networking. Meeting from 6:00 pm until 7:00 pm.


The cost includes nibbles and drinks.

People who register via the website:

  • Members $11.50 incl GST.
  • Non-members $17.25 incl GST
  • Student members free of charge.

People who pay at the door:

  • Members 15.00 incl GST
  • Non-members $20.00 incl GST
  • Student members free of charge.

Note: Members = members of TechCommNZ and affiliated organisations: NZATD, TWIA, PRINZ

About the speaker

Maree HorlorMaree Horlor is a technical communicator with 9 years’ experience creating content for help files and PDFs. In the past she’s planned and written documents for Trimble, supporting technicians installing software and hardware on some really big machines.

Always curious about different styles of writing, Maree started work with SLI Systems earlier this year writing API reference material. With one other writer, and plenty of support from developers and managers, they’ve worked through the complex process of choosing a writing tool and learning how to write documents for API developers. Phrases like “docs as code”, “endpoints”, and “key:value pairs” now have meaning!

In this presentation, Maree’s keen to demystify API document writing. Sadly, no amount of nibbles and nice slides will make writing APIs less complex, but if you start small and apply a little bit of persistence, anything is possible.

Event Registration