Stay updated
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)

Search results

Presentation recording -- 'Best practices in API docs: Product overviews and getting started tutorials'

by Tom Johnson on Oct 29, 2021 •
categories: technical-writingapi-docspodcasts

I recently gave an online presentation about product overviews and getting started tutorials in API docs, sponsored by the STC Washington, D.C.-Baltimore Chapter. This post provides a recording of the presentation and related details.

Video recording

Here’s the video recording:

Audio

If you want to listen to audio only, here’s the file:

Slides

Here are my slides:

Best practices in API docs: Product overviews and getting started tutorials

(Note: Use both the right and down arrows to move through the slides.)

Presentation description

Here’s a description of the presentation:

Best practices in API docs: Product overviews and getting started tutorials

For new users, two of the most important topics in API docs are the product overview and getting started tutorial. These two topics combine conceptual understanding with hands-on exploration. Together, these topics can ground users in a good understanding of your product and the confidence to implement it.

However, both of these topics are challenging. The product overview requires solid understanding of the whole product, described succinctly and clearly. Its content can overlap with marketing content and often has both engineering and business executive audiences. The getting started tutorial requires writers to handle an intricate balance of information — keeping the instructions brief enough to fit the end-to-end scope but also detailed enough for the user to be successful. The getting started tutorial needs to give the user success in working the product; this confidence will inspire the user to more advanced levels.

In this presentation, you’ll learn best practices, pitfalls, and other strategies for these two content types. Templates for each content type will also be provided. Additionally, we’ll look at several examples and assess them based on more formal criteria.

Event details

(Note: The event is over.)

Date Oct 28, 2021
Time: 8am PDT
Presenter: Tom Johnson
Organizer: STC Washington, D.C.-Baltimore Chapter
Cost: $0-$15, Eventbrite

I gave a similar presentation a couple of months earlier to tekom Europe. In the tekom Europe version, I didn’t have any examples and didn’t respond to audience chat during the presentation. But otherwise, the content is highly similar.

Buy me a coffeeBuy me a coffee
Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 6,100+ subscribers. (See email archive here.)

follow us in feedly

About Tom Johnson

Tom Johnson

I'm a technical writer / API doc specialist based in the Seattle area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.

Comments