Search results

Write the Docs Podcast episode 30: Documentation templates, with Juan Lara

by Tom Johnson on Jul 20, 2020
categories: wtd-podcasts writing

In Write the Docs Podcast episode 30, Juan Lara from Google joins us for a lively discussion about documentation templates.

Documentation templates refer to established patterns we follow for common documentation types, such as quickstarts, how-to guides, concepts, tutorials, reference, troubleshooting, release notes, FAQs, or other information types that have similar, predictable patterns.

Templates can be helpful in orienting new writers, but they can also help ensure consistency among larger groups of experienced writers too. Our discussion in this episode ranges from observations about when templates are right for users versus writers, and how templates fit into an overall content strategy and information architecture.

Beyond templates, your user’s goals and journeys will influence the shape of your help content.

Resources mentioned during the show:

You can see the original post here: WTD Episode 30: Documentation templates, with Juan Lara.

See also the Conceptual topics in API docs in my API docs course for a list of best practices about overviews, getting started tutorials, quick references, glossaries, and other common topic types more specific to API documentation.

About Tom Johnson

Tom Johnson

I'm an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.

If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.