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

Website: https://events.stcwdc.org/organizer/stc-washington-dc-baltimore-chapter-4/

STC Washington, DC - Baltimore Chapter

&lt;!-- sfs forms added to the_content - adding as a comment so that it will not display, but will it fool spammers?
	
	
	
	
	Name (required)
	
	Mail (will not be published) (required)
	
	Website
	
	
	
	
	
	
	
	
	
			
	
	
	Gimme a site!
	
	
	Just a username, please.
	
	
	
	
	User Name
	
	
	
	Password
	
	
	Remember Me
	
	
	
	
	
	--&gt;
	Best practices in API docs: Product overviews and getting started tutorials


<h1>About the Webinar</h1>
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 &#8212; 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. 

<h1>About the Instructor</h1>
Tom Johnson is a senior technical writer in Seattle, Washington. He is best known for his blog <a href="https://nam05.safelinks.protection.outlook.com/?url=http%3A%2F%2Fidratherbewriting.com&amp;data=02%7C01%7CTavia.Record%40wwt.com%7C71bf4936c0b04502e2fa08d794cc7e7f%7Ca2d8e6b4e26e44218f3dec288c827c7d%7C1%7C0%7C637141478344950702&amp;sdata=noGvlxQ1KwTc0hPb3z0url7jkUehwB1n3q0RCv4dwQs%3D&amp;reserved=0" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">idratherbewriting.com</a>, which has one of the largest followings in the tech comm community. Tom has also created an extensive online <a href="https://nam05.safelinks.protection.outlook.com/?url=http%3A%2F%2Fidratherbewriting.com%2Flearnapidoc&amp;data=02%7C01%7CTavia.Record%40wwt.com%7C71bf4936c0b04502e2fa08d794cc7e7f%7Ca2d8e6b4e26e44218f3dec288c827c7d%7C1%7C0%7C637141478344960703&amp;sdata=oP%2Bel2vcRgBZ4MX%2F%2BzH78xdFPQBXjvwMlkpOgX2PBQM%3D&amp;reserved=0" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">API Documentation Course</a>, which has helped hundreds of technical writers transition into API documentation. 

<h1>Event Access</h1>
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: <a href="mailto:events@events.stcwdc.org" target="_blank" data-msys-clicktrack="0" rel="nofollow noopener noreferrer">events@events.stcwdc.org</a>.
Webinar Host: Tavia Record
President and Professional Development Program Director
STC Washington, D.C.-Baltimore Chapter
president@wdcb.stcwdc.org

Our {communityGuidelinesLink} describe the sort of content we prohibit on Eventbrite. If you suspect an event may be in violation, you can report it to us so we can investigate.

To report other categories of prohibited or illegal content, submit {link}

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

More events from STC Washington, DC - Baltimore Chapter

Discover more events from STC Washington, DC - Baltimore Chapter, from Business to other experiences you might love.

Still looking for the right event?

Explore all online events to browse and filter by date, category, and more.

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

More events from STC Washington, DC - Baltimore Chapter

Discover more events from STC Washington, DC - Baltimore Chapter, from Business to other experiences you might love.

More Business events

Browse more Business events with different dates, prices, and formats to find your next great experience.

Still looking for the right event?

Explore all online events to browse and filter by date, category, and more.