Pre-Camp API Training – TC Camp 2019

API Documentation for Beginners

A full-day training session

Take your technical writing to the next level by learning how to write application programming interface (API) documentation.

APIs provide the means to work with everything from libraries to web services and even hardware, and this applies for both commercial products and services as well as free open source software (FOSS). Adoption rates of a particular software product or package often hinge on the quality of the accompanying API documentation. This is a specific area in which competent technical writers can provide significant value to employers and colleagues.

In this full-day workshop, we’ll introduce you to the structures and concepts that you’ll need to understand in order to get started in this fascinating and lucrative domain. We’ll begin with an overview of how are APIs used, what makes good API doc, and how to organize an API doc project. We’ll then build on that by looking at RESTful services, object-oriented libraries, command line interfaces, and IoT devices to identify the specific needs of each of these API types. We’ll also touch on the common open source tools and formats (such as markdown, OpenAPI/Swagger) that you can use to manage and build your documentation.

To get the most from the workshop, bring a laptop or tablet with a text editor (such as Notepad++, SublimeText, Atom, etc.) and access to the web. We’ll do a number of exercises designed to reinforce the concepts presented in class. If you have even the most cursory knowledge of a programming language, that’d be great, but it isn’t required.

Slides

Links from the presentation

Instructors

Joanna Bujes

J.A. Bujes has been writing software documentation for over thirty years, addressing topics like distributed computing, web services, operating systems, messaging middleware, source control systems, programming languages, development environments, and tools. She has also taught writing and technical writing at the college level.

Though her working days are winding down, she plans to write a textbook to share her experience and craft with aspiring technical writers. English majors have to eat too!

Paul Wallace has spent nearly a decade working concurrent roles as technical writer, doc tools developer, and localization engineer. He is a producer as well as avid consumer of API documentation, which he uses to write production code.

He currently works at Synopsys within its Software Integrity Group in San Francisco.

Logistics

Date and time: Friday 26 April 2019, 8:30am (Registration), 9:00am-5:00pm (Class)

Location: Dr. Martin Luther King, Jr. Library – Room 255

Cost: $140. Lunch and parking provided.

About WIFI Access in the Library: https://www.sjpl.org/wireless

NOTE: Tickets for the API Training Full-Day Class
are sold separately from the unconference

Adobe Ambassador Workshop – TC Camp 2019

Adobe Workshop at TC Camp 2019

Tech Comm Survival Merit Badge Training

The dangers are everywhere, and frankly, it takes too much time and effort to fix those same disasters again and again.

Join Matt Sullivan for his 2-hour Ambassador workshop where he’ll show you how to use a digital machete and tech comm compass to guide you through the tangled overgrowth that is most technical communication. 

Matt will share his own survival stories, but more importantly, he will use your tech comm experiences to show you how you can identify dangerous (but too common) tech comm scenarios and safely resolve them.

It’s the Unconference, after all, so topics may include but are not limited to:

  • localization
  • accessibility
  • content reuse
  • SEO
  • evaluation of need for structure
  • choosing the “right” tool mix based on content

And, of course, attendees will determine the topics and their order!

Prerequisites: No prerequisites needed for this session, but students are encouraged to bring a laptop with their content editor of choice (FrameMaker, RoboHelp, Flare, Word, Notepad, lump of coal, etc.) and working content as permitted.

We’ll be discussing strategies for reducing formatting effort and improving content reuse using either structured or unstructured documents.

When: 27 April 2019, 8:30 am – 10:30 am

Workshop leader: Matt Sullivan, Tech Comm Tools and Adobe Technical Communication Partner

Matt Sullivan

Matt is Adobe’s Ambassador to TC Camp. He is a content experience strategist who helps both large and small organizations deliver exacting content to their audience. He is a real world Eagle Scout and still uses the skills and knowledge he learned a few times a month. His daughters recently asked him to take them backpacking, but he’s pretty sure they’ll back off when they find out why backpackers need to carry a 6” trowel with them.

This workshop is free to attend

WordPress/SEO Workshop – TC Camp 2018

If you’re considering implementing a WordPress website, this is the workshop for you.

WordPress Wizardry: Tips, Shortcuts, & SEO Secrets for Tech Writers

In this two-hour workshop, you’ll learn how to unleash the magic of WordPress. You’ll learn how to navigate the software, master the editing interface, and tips to create optimized content.

When: 27 January 2018, 8:30 am – 10:30 am

Workshop leaders: Massimo Paolini and Alyson Harrold, Spectrum Group Online, LLC

Massimo loves data. He’s a wizard with Analytics, deciphering trends and interpreting graphs to help clients succeed on the Web. Massimo also has a knack for software, finding tricks and uncovering hidden gems in the quest for efficiency.

Enchanted with words at a young age, Alyson is happiest when creating and wordsmithing. Helping clients shape their story for the Web, she produces SEO magic. By the way, Alyson is no slouch when it comes to data; she can interpret heatmaps and page analytics with the best of us.