WTD Episode 30: Documentation templates, with Juan Lara
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,
1 Stunde 1 Minute
Podcast
Podcaster
A discussion podcast based on WTD topics and issues, focused on technical writing and documentation for software products.
Beschreibung
vor 5 Jahren
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.
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.
Weitere Episoden
57 Minuten
vor 4 Jahren
43 Minuten
vor 4 Jahren
59 Minuten
vor 4 Jahren
54 Minuten
vor 5 Jahren
In Podcasts werben
Kommentare (0)