32 episodes

Write the Docs is a series of conferences, local meetups, and Slack groups focused on all things related to software documentation. We consider everyone who cares about communication, documentation, and their users to be a member of our community. This can be programmers, tech writers, customer support, marketers, and anyone else who wants people to have great experiences with software. This podcast is focused on topics discussed and debated within this community.

Write the Docs Podcast Write the Docs Podcast

    • How To
    • 4.4 • 5 Ratings

Write the Docs is a series of conferences, local meetups, and Slack groups focused on all things related to software documentation. We consider everyone who cares about communication, documentation, and their users to be a member of our community. This can be programmers, tech writers, customer support, marketers, and anyone else who wants people to have great experiences with software. This podcast is focused on topics discussed and debated within this community.

    WTD Episode 32: Self-publishing and AsciiDoc, with Mehmed Pasic

    WTD Episode 32: Self-publishing and AsciiDoc, with Mehmed Pasic

    Many tech writers are familiar with using AsciiDoc for documentation, but did you know that you can also create fiction and non-fiction books with AsciiDoc, publishing to popular digital formats such as EPUB or PDF, along with HTML? In this episode of the Write the Docs podcast, we chat with Mehmed Pasic from Manning Publications about self-publishing, AsciiDoc, collaborative workflows between authors and editors, trends in book publishing, the most popular devices for consuming content, book versus video formats for technical content, and more.

    • 54 min
    WTD Episode 31: Strategies for site search, with Peter Levan

    WTD Episode 31: Strategies for site search, with Peter Levan

    So many documentation websites rely on search as part of their information architecture. But what do you actually need to consider if you want to make your site search return answers for users in relevant, efficient ways? Join Peter Levan from Funnelback with regular guests Chris, Jared, and Tom for a talk all about making search work well on your site. Some of the questions discussed include: Why can't you just let Google do the searching and indexing for you? Do you need to pay big money to get a site search tool? How do you make your docs site talk ?

    • 1 hr
    WTD Episode 30: Documentation templates, with Juan Lara

    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, 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.

    • 1 hr 1 min
    WTD Episode 29: Salary Survey results and WFH tips, with Eric Holscher

    WTD Episode 29: Salary Survey results and WFH tips, with Eric Holscher

    In this episode, we chat with Eric Holscher, co-founder of both Read the Docs and Write the Docs, about the recent that the WTD group conducted. This survey was launched in Fall 2019, and the results published were recently published. The salary survey covers details such as types of employment, job titles, roles, length of time in role, work location, annual salary, salary breakdowns by state, additional benefits, satisfaction, reasons for dissastisfaction, organization type, respondent demographics, and more. In addition to exploring the survey, we also chat about tips for working from home, especially given that both Eric and Chris have been working remotely for many years.

    • 56 min
    WTD Episode 28: UX writing - Starting and Scaling at your Company, Berlin WTD meetup

    WTD Episode 28: UX writing - Starting and Scaling at your Company, Berlin WTD meetup

    Episode 28 is a recording of a Berlin WTD meetup focused on UX writing processes, live streamed on March 9, 2020 at the Humanitec in Berlin. The meetup featured two speakers. Natasha Sarana, UX Writer at FlixMobility, talks about her company's attempts to include UX Writing in their research routine. She shares the main challenges they faced so far and how they deal with them. The second speaker, Roger Sheen, information architect and freelance UX Writer, talks about how the UI copy process at Wire evolved as the product matured. He covers gathering and aligning copy from source code, moving it to dedicated strings files to facilitate version control and localization, and setting up collaboration workflows with developers and external partners.

    • 1 hr 14 min
    WTD Episode 27: Starting a doc group/process when you're the first

    WTD Episode 27: Starting a doc group/process when you're the first

    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 when there isn't anyone else, when processes, contacts, tools, and other systems aren't documented or described anywhere? When you're first on scene, docs might not even be your full-time job but rather a task that's on the side of your desk and which you have to bootstrap from ground zero.

    • 57 min

Customer Reviews

4.4 out of 5
5 Ratings

5 Ratings

YDOINeedANickName12345 ,

Great podcast!

The topics and discussions are interesting and engaging.

My one suggestion is that they can improve the sound quality and mics they’re using. They often talk over each other or have awkwardly long pauses due to lag and connection issues.

Otherwise, I’m very glad I found this show.

Top Podcasts In How To

Listeners Also Subscribed To