Podcast: Using long-token contexts to quality check an entire API doc set

I'd Rather Be Writing Podcast Feed

Player FM - Internet Radio Done Right

39 subscribers

Ditambah nine tahun yang lalu

Kandungan disediakan oleh Tom Johnson. Semua kandungan podcast termasuk episod, grafik dan perihalan podcast dimuat naik dan disediakan terus oleh Tom Johnson atau rakan kongsi platform podcast mereka. Jika anda percaya seseorang menggunakan karya berhak cipta anda tanpa kebenaran anda, anda boleh mengikuti proses yang digariskan di sini https://ms.player.fm/legal.

Peak Travel

1
Why Petra Needs Its People 28:39

13 days ago28:39

Main Kemudian

Senarai

Suka

Disukai

28:39

For centuries, members of the B’doul Bedouin tribe lived in the caves around the ancient city of Petra, Jordan. Then, in the 1980s, the government forced the tribe to move in the name of preserving the geological site for tourists. But if the residents are forced to leave, and if their heritage has been permanently changed, then what exactly is being preserved? SHOW NOTES: Meet The Man Living in The Lost City Carved in Stone Jordan: Petra's tourism authority cracks down on Bedouin cave dwellers The tribes paying the brutal price of conservation “There is no future for Umm Sayhoun” Jordan’s Young Bedouins Are Documenting Their Traditions on TikTok Check out Sami's company Jordan Inspiration Tours Learn about your ad choices: dovetail.prx.org/ad-choices…

about a year ago 21:58

MP3•Laman utama episod

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.

330 episod

I'd Rather Be Writing Podcast Feed

Podcast: Using long-token contexts to quality check an entire API doc set

I'd Rather Be Writing Podcast Feed

39 subscribers

published about a year ago

Kongsi

MP3•Laman utama episod

330 episod

Semua episod

I'd Rather Be Writing Podcast Feed

1
Rethinking traditional approaches to release notes -- recording of WTD Australia presentation 56:52

8 weeks ago56:52

56:52

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.

I'd Rather Be Writing Podcast Feed

1
My 2025 trends predictions for tech comm 21:17

14 weeks ago21:17

21:17

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

I'd Rather Be Writing Podcast Feed

1
[Podcast] GenAI and Document360: Conversation with Saravana Kumar 49:36

27 weeks ago49:36

49:36

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

I'd Rather Be Writing Podcast Feed

1
Podcast: Task decomposition and complex tree diagrams 18:38

37 weeks ago18:38

18:38

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

I'd Rather Be Writing Podcast Feed

1
Podcast: Using long-token contexts to quality check an entire API doc set 21:58

37 weeks ago21:58

21:58

I'd Rather Be Writing Podcast Feed

1
Podcast: Using file diffs for better release notes in reference docs 17:31

37 weeks ago17:31

17:31

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.

I'd Rather Be Writing Podcast Feed

1
Podcast: Populating documentation templates using AI 22:47

37 weeks ago22:47

22:47

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

I'd Rather Be Writing Podcast Feed

1
Podcast: Gathering source material for context input 18:02

37 weeks ago18:02

18:02

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

I'd Rather Be Writing Podcast Feed

1
Podcast: Creating high-fidelity, thematically organized notes from engineering meetings using AI 15:29

37 weeks ago15:29

15:29

For AI tools to generate accurate information for documentation you're writing, you need to pass in source material. This usually means meeting with engineers and product managers to gather information about the product. In this tutorial, I share prompts for turning those meeting transcriptions into organized, readable meeting summaries. These cleaned up summaries can then function as input context for documentation-oriented prompts.…

I'd Rather Be Writing Podcast Feed

1
[Podcast] Uncovering and communicating the value of your tech comm teams' work, with Keren Brown 47:32

46 weeks ago47:32

47:32

In this podcast episode, I talk with Keren Brown, VP of Marketing and Value at Zoomin Software, about strategies for technical writers to demonstrate their value within their organizations, especially in light of recent layoffs in the tech industry. We discuss aligning documentation work with high-priority initiatives, quantifying the impact of technical writing, and making this work visible to executive leaders. Keren also shares insights on the changing landscape of technical writing skills in the age of AI and the role of translation in modern documentation workflows. Overall, this podcast will show you how to establish yourself as a highly...…

I'd Rather Be Writing Podcast Feed

1
[Podcast] Breaking ground: New API documentation course at UW, with Bob Watson 53:05

1 year ago53:05

53:05

In this podcast, I chat with Bob Watson about an upcoming API documentation course he'll be teaching at the University of Washington. Bob has extensive experience working as an API technical writer at big tech companies like Microsoft, Amazon, and Google. The UW reached out to Bob to develop this new course offering. The 14-week evening course will cover fundamentals like understanding developer behaviors, working with various types of APIs, publishing workflows, as well as hands-on practice. A key component is having students create API documentation portfolios they can use to demonstrate their skills.…

I'd Rather Be Writing Podcast Feed

1
My 2024 technical writing trends and predictions 28:28

1 year ago28:28

28:28

I've been mulling over whether to write a trends post this year. There's so much uncertainty, it's hard to feel confident about how the tech writing profession will play out. But little trends-related ideas keep surfacing in the back of my mind, so I decided to write out some of my thoughts. Before I jump into this, I want to say that I’m much more agnostic and unsure about directions this year. 2024 could be amazing, it could also be terrible. Or everything could be overblown and remain more or less the same. One thing is for sure: in predictions,...…

I'd Rather Be Writing Podcast Feed

1
Podcast: Notes and themes from Zen and the Art of Motorcycle Maintenance by Robert Pirsig 1:03:29

1 year ago1:03:29

1:03:29

These are some notes and thoughts from reading Robert Pirsig's classic philosophical novel, Zen and the Art of Motorcycle Maintenance, published in 1974. My reading here focuses more on the technical writing aspects and themes from the book. Some themes include Classic versus Romantic modes of thought, the concept of Quality, our relationship with technology, doing your own maintenance, caring about the work, peace of mind, systems thinking, multiple paths through a problem, troubleshooting, being in-the-scene versus removed, the road trip, effortless action, going with the flow, traveling along the backroads, and presence in the moment. I also include some...…

I'd Rather Be Writing Podcast Feed

1
Webinar recording: Experiments and use cases for AI from a tech writer’s perspective 1:02:34

1 year ago1:02:34

1:02:34

I recently gave a webinar titled 'Experiments and use cases for AI from a tech writer’s perspective' on December 8, 2023. The webinar was sponsored by the STC Washington, DC - Baltimore Chapter. In this presentation, I shared some personal experiences in using AI for different writing-related use cases, explaining what I’ve found helpful. These use cases and takeaways were all experiential, based on my experiments with using AI both in the workplace for documentation-related scenarios and writing on my blog.…

I'd Rather Be Writing Podcast Feed

1
30+ ways I’m using AI in everyday writing life as a technical writer, blogger, and curious human 44:33

1 year ago44:33

44:33

In this post, I provide over 30 real-life examples of how I'm using AI on a daily basis, not just for technical writing tasks but more broadly in life, including summarizing content, explaining concepts, answering questions, troubleshooting problems, and having engaging conversations for a variety of tasks and scenarios. In my view, AI use cases are ubiquitous, equivalent to the use cases for computers or the Internet in general.…

Selamat datang ke Player FM

Player FM mengimbas laman-laman web bagi podcast berkualiti tinggi untuk anda nikmati sekarang. Ia merupakan aplikasi podcast terbaik dan berfungsi untuk Android, iPhone, dan web. Daftar untuk melaraskan langganan merentasi peranti.