FB.getLoginStatus(function(response) { statusChangeCallback(response); }); { status: 'connected', authResponse: { accessToken: '...', expiresIn:'...', signedRequest:'...', userID:'...' } }

Events Calendar

For questions, please contact the events manager: events at events dot stcwdc dot org

Loading Events

« All Events

  • This event has passed.

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

28 Oct 2021 @ 11:00 am - 12:00 pm EDT

Starter slide for a presentation about API documents shows presenter nasme, date, time.

About the Webinar

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 determine 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.

About the Instructor

Tom Johnson is a senior technical writer in Seattle, Washington. He is best known for his I'd Rather Be Writing blog, which has one of the largest followings in the tech comm community. Tom has also created an extensive online API Documentation Course, which has helped hundreds of technical writers transition into API documentation.  Updated

Event Access

This workshop is offered through GoToMeeting and will be recorded. All registrants will receive the link to the event in their e-ticket.

Please download the free GoToMeeting app to attend on your smart device, or attend by pasting the event link into your web browser. If you have any questions, please contact: events@events.stcwdc.org.

Webinar Host: Tavia Record
President and Professional Development Program Director
STC Washington, D.C.-Baltimore Chapter

Print Friendly, PDF & Email
Share with others


28 Oct 2021
11:00 am - 12:00 pm
Event Category:
Event Tags:
, ,

Leave a Comment

flubbing flounders