WTD Episode 30: Documentation templates, with Juan Lara
MP3•Episoder hjem
Manage episode 344329415 series 3405918
Innhold levert av Write the Docs Podcast. Alt podcastinnhold, inkludert episoder, grafikk og podcastbeskrivelser, lastes opp og leveres direkte av Write the Docs Podcast eller deres podcastplattformpartner. Hvis du tror at noen bruker det opphavsrettsbeskyttede verket ditt uten din tillatelse, kan du følge prosessen skissert her https://no.player.fm/legal.
In this episode, 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.
…
continue reading
35 episoder