Épisodes

  • Rethinking traditional approaches to release notes -- recording of WTD Australia presentation

    Rethinking traditional approaches to release notes -- recording of WTD Australia presentation
    Feb 17 2025
    I gave a presentation to the Write the Docs Australia group on using AI to write release notes using file diffs, on Feb 16, 2025. Here's the recording, presentation description, and transcript.
    Voir plus Voir moins
    57 min
  • My 2025 trends predictions for tech comm

    My 2025 trends predictions for tech comm
    Jan 5 2025
    It's that time of year again when we take to analyzing trends. If you know me, you're probably gearing up for a load of AI-optimistic predictions because, as I've noted in previous posts like Unpacking the issues from AI, I'm an AI optimist. However, my AI optimism isn't based on hype or the current tech zeitgeist. Rather, I'm an AI optimist because my daily experiences using AI for technical documentation, especially API docs, throughout 2024 has shown it to be invaluable.
    Voir plus Voir moins
    21 min
  • [Podcast] GenAI and Document360: Conversation with Saravana Kumar

    [Podcast] GenAI and Document360: Conversation with Saravana Kumar
    Oct 6 2024
    This podcast explores GenAI in technical documentation scenarios, highlighting the AI features and capabilities provided in Document360. I talk with Saravana Kumar, CEO of Kovai.co, which makes Document360, about how AI is changing search functionality and reducing support costs in knowledge bases. We discuss practical applications of AI for technical writers, including automated tagging, SEO optimization, glossary creation, and more. Saravana shares about AI agent workflows, conversational search experiences, automating screenshot captures, and much more.
    Voir plus Voir moins
    50 min
  • Podcast: Task decomposition and complex tree diagrams

    Podcast: Task decomposition and complex tree diagrams
    Jul 28 2024
    This tutorial will help you understand task decomposition by guiding you through the process of creating a complex tree diagram that's too sophisticated for an AI tool to create at once. Whether you're creating tree diagrams or not, it doesn't matter. This is just an example of how to break down complex information into smaller chunks and pass it into AI.
    Voir plus Voir moins
    19 min
  • Podcast: Using long-token contexts to quality check an entire API doc set

    Podcast: Using long-token contexts to quality check an entire API doc set
    Jul 28 2024
    One of the advantages of recent Gen AI updates is the massive token input context. When you can pass in an entire set of documentation as an input, you have a much stronger possibility for powerful prompts. In this tutorial, I share some quality-control prompts you can use that deal with entire doc sets as inputs, as well as explain some of the challenges in passing in an entire doc set.
    Voir plus Voir moins
    22 min
  • Podcast: Using file diffs for better release notes in reference docs

    Podcast: Using file diffs for better release notes in reference docs
    Jul 28 2024
    You can use AI prompts when creating release notes for APIs by leveraging file diffs from regenerated reference documentation. The file diffs from version control tools provide a reliable, precise information source about what's changed in the release.
    Voir plus Voir moins
    18 min
  • Podcast: Populating documentation templates using AI

    Podcast: Populating documentation templates using AI
    Jul 28 2024
    In this tutorial, you'll learn how to use AI to populate documentation templates with the source material you've gathered. For example, API overviews often follow a highly structured template. This technique can be a quick way to get an initial draft of documentation, which you can then edit and review with SMEs.
    Voir plus Voir moins
    23 min
  • Podcast: Gathering source material for context input

    Podcast: Gathering source material for context input
    Jul 28 2024
    One of the most successful strategies for using AI is to pass in an abundance of source material that can augument and inform the AI's responses. In this tutorial, I cover strategies for gathering this material, including what types of documents to look for, optimal ordering, pitfalls to look out for such as outdated or slanted information, and more.
    Voir plus Voir moins
    18 min