אודות פרק זה
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.
אנגלית
ארצות הברית
תעתיק 🔗
Are you the producer of this podcast?
Add a podcast transcript
Need Audio-to-Text?
Transcribe with Listen411 in Just 60 Seconds
פרקים אחרים בפודקאסט הזה
In this episode, we're joined by the Write the Docs Australia initiator Swapnil Ogale. We talk about conference wind-downs and ramp-ups, highlights from the just-finished WTD Prague conference, speakers announced for upcoming Write the Docs Australia conference, the Good Docs Project, the tech wri…
In this episode, rather than the usual roundtable discussion, we provide a recording of a WTD Berlin presentation by Lucie Le Naour on how to write inclusive tech documentation. Inclusive documentation takes into account all users, regardless of their gender, culture, or abilities. It uses languag…
In episode 26, we talk with Alan Bowman about the technical writing forum on Reddit as well as the WTD Slack channel, comparing and contrasting the two spaces. Topics covered include pros and cons of anonymity on the internet, transparency around sensitive or taboo topics (e.g., salary, masters pr…
In episode 25, we talk with Andrew Head, Ph.D. Candidate in Computer Science at UC Berkeley, about his research on how developers use API documentation. Specifically, we focused on a recent article he co-authored titled When Not to Comment: Questions and Tradeoffs with API Documentation for C++ Pr…
In episode 27 of the Write the Docs podcast, we're joined by Cynthia Ng and Amy Qualls from GitLab to talk about strategies for starting up docs in organizations where there aren't any other tech writers and where you're first on scene setting up shop. What are your first steps as a documentarian …
הצהרה: הפודקאסט והגרפיקה המוטבעים בדף זה הם מ-Write the Docs Podcast, שהוא רכושו של בעליו ואינו קשור או מאושר על ידי Listen Notes, Inc.
