Explorez tous les épisodes du podcast The Not-Boring Tech Writer
| Titre | Date | Durée | |
|---|---|---|---|
| Kate sounds off on content types | 06 Feb 2025 | 00:16:04 | |
In this solo episode, I share what I'm currently working on, reflect a little on teaching my first Knowledge Management Master Class with KnowledgeOwl, and dig into why and how I'm going to start using content types. — My current in-flight projects include updating nearly all of our documentation to reflect major changes to our user interface, which includes changes to screenshots, navigation options, and section/subsection labels. I’m also working on my long slog to convert all our screenshots from .png to .webp format. As I make all of those updates, I’m bringing our content into line with our current style guide (the first time I’ve used an explicit style guide in the KnowledgeOwl Support Knowledge Base). I recently finished teaching my first Knowledge Management Master Class with KnowledgeOwl. This was mostly a success, though it was a sharp learning curve for me and I’m already full of ideas on what to do differently next time. It also humbled me since it made me view my own docs through the lens of all the best practices I was suggesting people employ–and realizing how often my docs fell short. For me, the most fascinating takeaway was really digging into the concept of concept types or information typing. I’ve never done this as an explicit, intentional exercise. After researching various approaches, I’m sold on the underlying concept. My plan is to create some templates for each major content type, using The Good Docs Project’s templates as a starting point). I’m then going to use those templates as I update content in our Features category to test and refine the templates before gradually applying them to the entire knowledge base. I’ll be using tags to track my progress and identify the content type for each page, too. In Episode 5, I’ll report back on how I’m doing in my endeavors! Resources discussed in this episode:
—
Contact Kate Mueller: Contact KnowledgeOwl: | |||
| Developer collaboration with Lorna Mitchell | 23 Jan 2025 | 00:43:46 | |
In this episode, I’m talking with Lorna Mitchell, a technology leader, published author, tech blogger, and developer experience expert who is passionate about APIs and developer tools. We talk about why developers writing docs is good for both your devs and your docs, the best ways to build successful collaboration with developers, and more! — Lorna and I discuss her background as a developer who started doing documentation for her own resources and gradually moved into developer relations, developer advocacy, and developer experience. We chat about the wide range of writing she’s tackled–including books, readmes, and her blog–and why developers need to write to improve their skills. We also discuss strategies tech writers can use to facilitate good collaboration with developers, including treating their role more as editors rather than writers; having a clearly-defined process with discrete, well-scoped requests for contributions; creating content type templates to streamline contributions; and having a second, shorter style guide for developers. About Lorna Mitchell: Lorna is based in Yorkshire, UK; she is a technology leader and developer experience expert who is passionate about APIs and developer tools. She is also a published author and regular blogger, sharing her insights on a variety of tech-related topics. Lorna serves on the OpenUK board, is on the Technical Steering Committee for OpenAPI specification, and maintains open source projects. Resources discussed in this episode:
—
Contact Kate Mueller: Contact Lorna Mitchell: Contact KnowledgeOwl: | |||
| Skill #34: Crowdsourcing Technical Communication | 27 Feb 2020 | 00:37:04 | |
Folk working in technical communication—whether they’re academics or practitioners—through their own unique skill sets, perspectives, and experiences, often discover best practices to excel at their job. These hard-earned insights would likely benefit others facing similar challenges; however, silos often keep folk in technical communication from quickly disseminating what they’ve learned. That’s why Dr. Chris Lam—technical communication professor at the University of North Texas—created CrowdsourceTPC: a crowdsource platform that gives folk in technical communication and opportunity to share their insights and little wins—giving others an opportunity to use and adapt them for their own needs. In this episode, Chris joins us on the podcast to discuss the inspiration behind CrowdsourceTPC and how others can make the most of the platform. Show notes: | |||
| Skill #33: Getting Started with Open Data | 10 Feb 2020 | 00:43:26 | |
For the civically-mind technical writer, there’s a growing movement in cities across the world where technical writers can use their skills to better their community. It’s called Open Data Day: an annual celebration of open data groups around the world partnering with local governments to use open data to achieve a shared goal in the community. From analyzing environment data to tracking public money flows, open data day gives citizens—from data folk to advocates—an opportunity to get the data they need to take action in their communities. As a tech writer, you may not initially see how your skills fit into open data. However, as you’ll learn in this episode, success open data day’s need compelling narratives to complement outcomes, tutorials to teach people how to access the data for their own uses, and much more—all areas in which the tech writer succeeds. That’s why, in this episode, I have Jesse Hamner and two-time guest on the podcast—longtime open data advocates who’ve seen first-hand the value of the tech writer. In this episode, Jesse and Kyle help us understand the value of open data and how the civically-minded technical writer can get plugged into this exciting movement. Show notes: | |||
| Skill #32: Understanding Translation and Localization | 26 Jan 2020 | 00:31:03 | |
As products and services reach markets outside of their geographic origins, organizations must consider how to translate and localize their existing documentation. It’s a must, as these new users will need to refer to a knowledge base. But how exactly do organizations translate their documentation? Do they copy and paste all of their content into Google Translate? Do they hire technical writers who speak and write the language of the new market? As you’ll learn in this episode, successful organizations partner with translation and localization vendors, who ensure users in new markets understand the content. To help us dig deep into this skill, we have Mike McDermott on the podcast: Director of Language Translations at MadTranslations, a translation service created by MadCap software. For nearly eight years, Mike has helped clients translate their content into several different languages. In this episode, Mike share insights he’s learned along the way to ensure any organization has a seamless, successful translation process, including how to research the right translation service, who to get involved in the research process, and how to create content optimized for translation. Show notes: | |||
| Skill #31: Choosing the Right Knowledge Base Software for Your Organization | 20 Jan 2020 | 00:50:09 | |
No matter your industry—tech, nonprofit, marketing—your organization likely needs a knowledge base software, a dedicated place to capture essential knowledge. However, choosing the right knowledge base software can be challenging—and takes much more work then a quick Google search. You need to understand the core knowledge problems within your organization; compare softwares that, on the surface, may look a lot alike; and get buy in from key players who’d actually use the knowledge base. That’s why in this episode, we have Kate Mueller on the podcast: Support Sorceress and—I kid you not—cheese monger at KnowledgeOwl: a knowledge base software that, as they share on their site, makes one thing - awesome knowledge base software. Kate has worked with several different knowledge bases throughout her career and, at KnowledgeOwl, works with current and prospective customers across the world to help them discover how knowledge base softwares can help address their needs. In this episode, Kate reflects on her career—both as a user of and support member for knowledge base software—to share the criterion you should consider as you choose the right knowledge base for your organization, including how to get started in your research, how to get company buy-in, and which essential features you should look for in a knowledge base. And, in the end, Kate shares a few of her favorite knowledge bases—KnowledgeOwl and beyond—to jump-start your research. Show notes: | |||
| Skill #30: Landing a Tech Writing Internship | 30 Nov 2019 | 00:34:51 | |
As prospective tech writers look for ways to get into the tech writing field, many pursue internships. And understandably so: internships give prospective tech writers hands-on experience in tech writing, giving them an opportunity to boost their skills and get a feel for the industry. However, finding that tech writing internship can be challenging, especially if you aren’t pursuing a tech writing related degree in university. That’s why, in this episode, we have German tech writer Joachim on the podcast, who’s six weeks into his first tech writing internship. Joachim has learned several lessons about how to find and thrive in a tech writing internship, which you’ll find helpful no matter where you live. | |||
| Skill #29: Understanding Your Reader (as a Whole) | 18 Nov 2019 | 00:35:16 | |
One of the most important skills tech writers can have is the ability to analyze their audience—researching who’s using the product their documentation, understanding how they it, and most important, ensuring their goals are reflected in the documentation. But as tech writers research their audience, digging deep into insights such as demographic and preferred device, tech writers can, admittedly, get caught up in the technical side of audience analysis and dismiss opportunities to understand their reader as a whole. That’s why in this episode, we have Alexander Yant on the podcast: occupational therapist turned tech writer advocate who, as he’s searched for tech writing opportunities for himself, has reflected on his career in healthcare to share must-have insights for tech writers hoping to better understand their audience. In this episode, Alexander shares how you can understand your readers as a whole, including why empathy is one of the most important aspects of audience analysis, how tech writers can boost their audience analysis skills, and how effective audience analysis can demonstrate your value as a tech writer. Show Notes: | |||
| Skill #28: Researching as a Tech Writer | 31 Oct 2019 | 00:27:36 | |
All of the help resources tech writers create, such software documentation, video tutorials, or blog posts, require research. Imagine creating a document to explain a new feature before, say, even understanding how customers actually use the feature. Tech writers use several different resources to research the information they need, including conversations with developers and support and reviewing support tickets. But, if you’re like many writers, we’ll often seek too much information and face information overload, uncertain what to document. Or, as we’ll learn from this episode’s guest, we miss an opportunity to research the domain in which we work—a must for any tech writer, no matter their industry. That’s why, in this episode, we have Margaret Eker on the podcast: tech writer at Magento, an Adobe company, and somewhat longtime friend since our days hiking in the forests of Portland Oregon for Write the Docs 2016. Margaret prides herself as a researcher. And, countless times, has witnessed her work and relationships with her colleagues flourish when she dedicates herself to understanding the domain in which her company exists. In this episode, Margaret shares how you can boost your research skills as a technical writer, including how tech writers traditionally research new features, why tech writers should research the domain in which they work, and which steps you can take today to boost your research skills. Show Notes: | |||
| Skill #27: Contributing to GitHub | 24 Oct 2019 | 00:25:39 | |
As tech writers consider how to stay relevant in the field, many look to GitHub—the git repository service where people host their open-source projects, allowing others to contribute as well. And understandably so: as the demand for tech writers specialized in developer documentation grows, GitHub gives tech writers low-lift opportunities to ramp up their skills. That’s why, in this episode, we have Tad Dieken on the podcast: two-time guest on the not-boring tech writer podcast and tech writer at Accuray, who recently completed a week straight of GitHub contributions, ranging from creating onboarding guides for new tech writers to translation. In this episode, Tad shares how to get started contributing to GitHub, including how to find projects that interest you, how to overcome imposter syndrome in GitHub, and which new skills you may learn in the process. Show Notes: | |||
| Skill #26: Getting Started in API Documentation | 01 Oct 2019 | 00:38:19 | |
As tech writers consider how to stay relevant in the field, many consider getting started in API documentation. And who can blame them—it’s one of the most trending and highest paying roles in tech writing. But getting started in API documentation can be intimidating, especially if you’ve never worked with code. That’s why, in this episode, we have Tom Johnson on the podcast: creator of the tech writing site, I’d Rather be Writing, and technical writer at Amazon. In this episode, Tom shares how to get started in API documentation, including where the tech writer fits in the API documentation process, what skills tech writers need to excel at API documentation, and where to find the best resources to ramp up those skills. Show Notes: | |||
| Skill #25: Nudging Users to Action Through Contextual Help | 24 Sep 2019 | 00:23:14 | |
As technical writers, we help users learn processes or complete particular tasks. And we offer this help in several ways, including documentation, video tutorials, or learning management systems. But get this: through gentle nudges and clues throughout the users’ journeys, technical writers can help users achieve their goal without sending them straight to the help site. How? Through contextual help: the micro-copy, in-app guides, and info tips that developers and user experience designers include in their product to nudge users to action. You’ve seen examples of contextual help. Think the copy that appears below free form fields, instructing you to enter certain content; or guided steps introducing you to a new interface. This is contextual help. And you—the technical writer—are best equipped to create it for your company. That’s why, in this episode, we have Kacy Ewing on the podcast: fellow graduate of the University of North Texas and tech writer out of Austin, Texas—though soon moving to Brooklyn, New York to begin a new tech writing job with Bloomberg. Kacy has created several forms of help resources—including contextual help—and, in this episode, shares the skills you need to excel in creating contextual help for your employer, as well, including:
Show Notes: | |||
| Introducing The Not-Boring Tech Writer Reboot | 09 Jan 2025 | 00:12:46 | |
Meet our new host Kate Mueller and get the inside scoop on how The Not-Boring Tech Writer (TNBTW) will work moving forward. — Kate Mueller is the Documentation Goddess of KnowledgeOwl, a seasoned technical writer and owner of knowledgewithsass, a knowledge management coaching service. She’s written and maintained documentation for companies in broadcasting, financial services, IT, and software for 15+ years. She’ll be hosting TNBTW moving forward. In this episode, Kate discusses her vision for TNBTW: a podcast dedicated to everyone who is writing technical documentation, including those who may not feel comfortable calling themselves tech writers. Whether you create product documentation, support documentation, READMEs, or any other technical content—and whether you deal with imposter syndrome, lack formal training, or find yourself somewhere in the gray area between technical communications and general writing—the TNBTW reboot might be your new favorite podcast. Kate talks about her own imposter syndrome using the tech writer label and recounts her tech writer villain origin story. We plan to release two episodes per month: one episode will maintain the traditional TNBTW format of interviewing a guest and focusing on useful skills or tools that can help you improve your tech writing skills; the other episode will be a behind-the-scenes look into what Kate’s working on, struggling with, or thinking about in her daily tech writing life. —
Contact Kate Mueller: Contact KnowledgeOwl: | |||
| Skill #24: Finding Your Content DNA | 17 Sep 2019 | 00:29:39 | |
John Espirian—technical copywriter and author of the soon-to-be-released book Content DNA—describes content DNA as the "shape" of your brand and then using the power of consistency and congruence to create content that gets remembered and acted on. As technical communicators, the content DNA could take several forms: a freelance technical writer could use their content DNA to own their niche; a content marketer could discover their employer’s content DNA to create compelling, sales-boosting content. In this episode, John shares how you can find your own content DNA, including:
Show Notes: | |||
| Skill #23: Transitioning into Tech Writing from Very-Much-Not Tech Writing | 30 Aug 2019 | 00:30:52 | |
Think back to the early years of your career as you considered pursuing a career in technical writing. Unless you happened to pursue a formal education in technical writing; and perhaps land an internship, it’s a challenging period—just like any career change. You have to learn the jargon of the technical writer; the networks with which they mingle; and the skills they use. For people working in very-much-not technical writing hoping to make the transition, all of it can be overwhelming. That’s why, in this episode, I have Chad Sterling on the podcast: Product Technical Communications Specialist at Kuka, an Austin-based robotics company. Before Chad joined Kuka, he worked as a hotel security director across the united states. He enjoyed—and excelled at the work—however, after discovering his skill for writing and interest in technology, he made the switch to technical writing and has an excellent story to share about the process. In this episode, Chad shares how you can transition to technical writing from very-much-not technical writing including:
Show Notes:
| |||
| Skill #22: Using Your Detective Skills as a Technical Writer | 26 Aug 2019 | 00:35:51 | |
As technical writers, we often wear many different hats within an organization: we write documentation that teaches people how to use a product; we test new features to ensure they’re working properly; we write marketing copy that encourages people to research a product. But, as you’ll learn in this episode, we wear another hat that perhaps haven’t considered but is essential to the technical writers’ skill set: the detective hat. That’s why, in this episode, I have Jamie Roddy on the podcast: Manager of Technical Communicators who leads a team of global technical communicators who, from her love of detective shows, has found that the detective and the technical writer have a lot alike. In this episode, Jamie shares how you can use your detective skills as a technical writer, including:
Show Notes: | |||
| Skill #21: Mentoring Prospective Tech Writers | 19 Aug 2019 | 00:30:15 | |
All technical writers can look back on their career and likely think of a specific person or two who helped them advance their career. It could be a former professor who encouraged them to take technical writing courses; a friend who introduced them to the field; or a boss who invested time into their work. For prospective technical writers, these mentors are essential to professional development—and landing that first sweet, sweet tech writing job—because they take the time to understand the mentees hopes, dreams, and struggles (and come alongside to help throughout the process). That’s why, in this episode, I have John Paz on the podcast: Senior Content Designer at Atlassian and mentoring wizard, who’s helped several current and prospective tech writers navigate the field and make the most of their skill sets. In this episode, John shares his experiences as a mentor to prospective tech writers, and how you can do the same, including
Show Notes: | |||
| Skill #20: Understanding Content Marketing | 12 Aug 2019 | 00:28:12 | |
As technical writers, we excel at turning technical information into documentation that helps users understand complex concepts. We write software documentation that helps users understand a product; we create video tutorials that teach users how to use a feature. Software documentation is the technical writers’ bread and butter; however, perhaps unknowingly, technical writers could also thrive at content marketing: a form of marketing that shares a company’s story and expertise in an interesting, sales-boosting way. To help us unpack this skill, we have Chad Lott on the podcast: Senior Copywriter at Zenreach, who, everyday works in the full suite of content marketing—from corporate blog writing to Google Ad Words. In this episode, Chad shares his experiences as a content marketer, plus, shares tips on how you can transition into the field, including
Show Notes: | |||
| Skill #19: Writing for Nonprofit Organizations | 29 Jul 2019 | 00:25:01 | |
Throughout technical writers’ careers, they may find themselves working in several different industries: they could start their career writing end-user documentation for a software company; shift to healthcare to write white papers; maybe transition into marketing to write web copy. And this shouldn’t surprise us: technical writers have several skills that transfer well to different industries. That’s why, in this episode, you’re going to learn how to write for an industry that you perhaps haven’t considered—or, if you’re like me before I recorded this episode, you had a limited understanding of its opportunity. And that’s writing for nonprofit organizations. Turns out, technical writers have far more opportunities to contribute to a nonprofit’s mission beyond grant writing—and it this episode, you’ll learn how to use your technical writing skills to capture those opportunities. To help us unpack this skill, we have Kathleen Franks on the podcast: recent graduate of Auburn University’s Tech Comm Masters program and—throughout university— used her technical writing skills to assist several nonprofits. In this episode, Kathleen shares how you can use your skills to start writing for nonprofit organizations, including:
Show Notes: | |||
| Skill #18: Embracing the Long Game of Technical Writing | 22 Jul 2019 | 00:29:41 | |
Anyone who’s been in technical writing for a few years or has attended a technical writing conference has witnessed how quickly the field has evolved. Technical writers have had to shift from Microsoft Word docs to single-source authoring; they’ve had to learn how to become project managers; they’ve had to learn basic programming skills. In short, technical writers have had to learn how to be flexible—shifting their skills and focus as needed to prepare themselves for shifts in the industry. It’s essential to surviving the long game of technical writing; however, it’s not easy. It can require continuing education outside of your 9 to 5; it can mean feeling very uncomfortable in a new setting; and, most important, it can mean, understandably, forgetting to create a enjoyable life for yourself outside of work. That’s why, in this episode, we have Jody Winter on the podcast: Auckland, New Zealand based technical writer of 15 years who’s faced all the struggles that come with embracing the long game of technical writing—and, thankfully, has lived to tell the story with insights that will help any technical writer prepare for and embrace the challenges of growing and fostering their career. In this episode, Jody shares how you can embrace the long game of technical writing, including:
Show Notes: | |||
| Skill #17: Branding Your Work | 30 May 2019 | 00:39:41 | |
As a technical writer, you’ve likely not considered branding yourself and your work—and understandably so: your documentation—no matter how masterful and easy to understand—often isn’t associated with yourself. You don’t get a byline; you don’t get a image of yourself below the headline; instead, it’s just another piece of content created by “the documentation team.” However, that doesn’t mean there’s value in creating your brand as a technical writer. And you can do so in ways that align with your philosophy and perspective of the industry. Take Tom Johnson, for example, who’s built a brand for himself around his tech writing site, I’d Rather Be Writing (which, I highly recommend, as you’ll sense in this episode); or Sarah Maddox at Google Maps, who’s built a brand through her site, Ffeathers, combining her interests in technical writing and science fiction. You have a unique perspective on technical writing that could build your brand while helping your peers lead more fulfilling careers—and in this episode, you’re gonna learn how to do it. We have Ash Blankenship on the podcast: former fellow podcast co-host at Parskify podcast, where we first met, and today, is the founder at Acme Design: a web design agency that helps entrepreneurs and creatives build their brand. In this episode, Ash shares how you can find your unique perspective on technical writing to brand your work, including:
Show Notes: | |||
| Skill #16: Using Cognitive Science to Make Your Technical Writing More Interesting | 30 Mar 2019 | 00:31:43 | |
As a technical writer, what does it mean to make your writing interesting? It’s a question you perhaps have never pondered—and understandably so: you spend your time ensuring that your docs are correct and easy to understand for users—not so much that the work is interesting to read. It’s a comfortable approach to technical writing that’s easy to get stuck in—however, to the detriment of our work. Enter Anne Janzer: this epsiode’s guest and author of, well, several great books, but as we’ll highlight today, Writing to be Understood. In her book, Anne discovered the essential techniques to making nonfiction writing more interesting for readers, including how to use analogies effectively to illustrate unseen concepts, appeal to readers’ innate curiosity, and balance humility with credibility. In this episode, Anne shares takes her research on making nonfiction writing more interesting and shifts the focus to how technical writers can apply the concepts as well. We discuss:
Show Notes: | |||
| Skill #15: Transitioning into Instructional Design | 24 Mar 2019 | 00:21:36 | |
Instructional design, as described by my guest, instructional designer Katie Price, means you create courses to help people—whether it’s students at a university or end-users for a product—learn a new subject. Take Lynda, for example: the career development website from LinkedIn. You visit the site to learn a new skill—and you find a course that, through videos, powerpoints, graphics, and good ole’ written content, teaches you that skill. That’s instructional design and—as you’ll learn in this episode—it’s a wonderful career move for technical writers hoping to transition into a new field. To help us unpack this skill, I’ve got Katie Price, instructional designer at Azusa university, on the podcast to share with us how technical writers can transition into instructional design, including:
Show Notes: | |||
| Tech Writer Advocacy and Managing Write the Docs with Swapnil Ogale | 14 Jun 2021 | 00:37:31 | |
In this episode I’m talking to Swapnil Ogale, a Technical Writer Advocate for Redocly based in Melbourne, Australia, who is also a Community and Conference Manager for Write the Docs. He gives us the inside scoop on arranging Write the Docs events conferences both in-person and online, and talks to us about the importance of advocacy for technical writers. | |||
| Skill #14: Contributing to Open Source Projects | 28 Feb 2019 | 00:27:48 | |
An open source project is a software program that’s open for anyone to use or modify as they see it. For example, a developer—anywhere in the world—could create an open source project that gives users real-time updates on the location of, let’s say, city buses. The developer had the idea, coded the software, then released a rough version to the world. It likely has bugs and missing features. But because it’s open source, anyone who’s interested in the project can use their expertise to make the project better—including technical writers. As you’ll learn in this episode, documentation is essential to a successful open source project. However, for developers actually coding the software, documentation is an afterthought. The result: possible users don’t know what the software does—and even if they do—they struggle to figure out how to use it. This is where technical writers—both new and seasoned—can use their skills not only to contribute to the beauty that is open source projects, but also challenge themselves to learn new types of documentation. To help us unpack this skill, I’ve got Kyle Taylor, solutions architect at FFW and President of a Denton-based technology nonprofit TechMill, on the podcast to share with us how technical writers can contribute to open source projects, including:
Show Notes: | |||
| Skill #13: Getting Your First Job in Technical Communication | 12 Dec 2018 | 00:29:33 | |
Thaddeus Dieken – Technical Writer at Accuray – shares how you can get your first job in technical communication, including how to effectively search for jobs, market yourself as a qualified entry-level candidate, and how to navigate the workplace. | |||
| Skill #12: Teaching Technical Writing | 30 Oct 2018 | 00:25:52 | |
The technical writer has a variety of valuable skills – such as making documents enjoyable to read and complex topics easy to understand – however, the skill that I think is most valuable for the technical writer is the desire to stay relevant and advance their career. So we pick up a programming language; we get continued education; we dig into API documentation, hopefully through Tom Johnson’s course on his site, I’d rather be writing. But there’s another way to advance our career in technical writing – one that many of you in industry have perhaps never considered: teaching technical writing. Jobs in teaching technical writing are rising – a great opportunity for the new and seasoned technical writer alike to make a career shift – and in this episode, our guest, Kim Campbell, professor and chair of Technical Communication at the University of North Texas, will tell you how to make it happen, including:
Show Notes: | |||
| Skill #11: Surviving in the Dev World | 01 Oct 2018 | 00:36:28 | |
We all know that successful technical writers are more than writers: they’re designers; they’re knowledge managers; they’re support. However, for technical writers in the dev world, they’re expected to gain new skills, particularly, understanding (and writing) programming languages. That’s a challenging next step for technical writers – and understandably so: We can create docs, but introducing programming languages can make technical writers wonder what it really takes to survive in the dev world. In this episode, I chat with Michal Skowron and Pawel Kowaluk – technical writers at Guidewire Software in Kraków, Poland – about how you can survive in the dev world, including:
Show Notes: | |||
| Best of 2016 | 01 Jan 2017 | 00:25:17 | |
2016 was a lovely year for The Not-Boring Tech Writer podcast. We had 10 episodes with 11 guests, covering a variety of topics that truly captured the theme of the podcast: how technical writers can break the stereotype that technical writing is a boring career. This episode includes my favorite segment from each of the 10 episodes. So if you hear a segment that interests you and haven’t dove into its episode – now is your chance. Thank you, listeners, for supporting The Not-Boring Tech Writer, and I look forward to bringing you more episodes in 2017. Show Notes: | |||
| Skill #10: Implementing Single-Source Authoring | 12 Dec 2016 | 00:28:46 | |
Paul Stoecklein knows documentation: As Documentation Manager at MadCap – the industry leader in documentation software – and longtime technical writer, Paul understands what does and does not work for documentation teams. A methodology that Paul believes is essential for documentation teams is single-source authoring: to use a single-source of documentation for multiple outputs. In this episode, Paul shares how you can implement single-source authoring in your organization, including:
Show Notes: | |||
| Skill #9: Creating a Human Connection in Your Documentation | 07 Oct 2016 | 00:19:38 | |
We’ve all read (and perhaps written) a boring document: the robot-like language, the walls of text. And we’re all familiar with the result: a disengaged reader who’s likely missed the message. Enter John Espirian, freelance technical writer and Director at the Society for Editors and Proofreaders. John believes the difference between a boring and a not-boring document comes down to one essential element: a human connection. In this episode, John shares how you can create that human connection in your documentation, including:
Show Notes:
| |||
| Skill #8: Acquiring the Three Types of Knowledge Tech Writers Need to Succeed | 02 Aug 2016 | 00:38:02 | |
Knowledge – as technical writers, it’s one of our greatest assets. However, amid the information overload technical writers often face, it’s also one of the most difficult assets to acquire. Enter Tom Johnson and Lisa Meloncon. Today’s guests and tech comm. advocates that have graciously shared how you can filter the information overload and shift your focus to the three types of knowledge you need to succeed:
The Show Notes: | |||
| Skill #7: Preparing for the Future of Tech Comm | 09 Jul 2016 | 00:29:08 | |
As the tech comm industry develops, technical writers must embrace a sobering truth: As Dr. Stan Dicks writes in Digital Literacy for Technical Communication, “Technical communicators who add value to their organizations do not merely write and edit documents.” So how do we prepare for the future of tech comm so we can ensure we’re adding value to our organizations? Preparing for the future is difficult without a compass – but fortunately – Ted Hudek, Senior Programming Writer at Microsoft, knows the way. In this episode, Ted shares his tips on how you can prepare for the future of tech comm, including:
The Show Notes: | |||
| Skill #6: Bridging the Gap Between Documentation and Support | 28 Jun 2016 | 00:24:39 | |
Documentation and Support teams share a common goal: to give customers the information they need to get the greatest value from a product. But despite a shared goal, consistent communication rarely follows. The result: tech writers missing out on content-rich customer feedback, thus, as our guest Neal Kaplan phrases it, “creating documentation in a vacuum.” In this episode, you’ll learn how to bridge the gap between Documentation and Support, including how to:
The Show Notes: | |||
| Documentarians for Diplomacy: Bringing the Mirth with Kat Stoica Ostenfeld | 07 May 2021 | 00:50:44 | |
We’re back after a short and unexpected break! Sorry to keep you waiting! This episode you’ll hear Kat Stoica Ostenfeld, an accomplished tech writer living in Copenhagen in Denmark. A linguist by credential, she says diplomacy is the key to being an effective documentarian, and shares how her translation and applied linguistics background helped her find common understanding and success in the world of technical writing. Additional topics: Beautiful limestone buildings; puppy chat; spouse sacrifices; documentation as its own pillar; language proficiency vs successful communication; the meaning of “documentation”; linguistics applied; the diplomacy of being a tech writer; full stack teams; writing rage; linguistic detective work. The Not-Boring Tech Writer - feedback survey Twitter - Kat Stoica Ostenfeld | |||
| Skill #5: Getting Involved in a Community | 19 May 2016 | 00:33:13 | |
We’ve all experienced the joy of community: colleagues mentor you; friends encourage you; strangers point you towards their favorite pizza shop downtown. For that moment, whether you had previous ties to each other or not, you feel that sense of community. And while every community is unique, one concept is constant: As urbanist Charles Montgomery defines it, “people gathering, talking, and helping one another everyday.” Eric Holscher (today’s podcast guest) and Troy Howard have captured that concept and created a community for us – the tech writers. The community: Write the Docs. In this episode, Eric shares the story of Write the Docs and describes the power of getting involved in a community, including:
The Show Notes: | |||
| Skill #4: Understanding UX Design | 16 May 2016 | 00:25:01 | |
Where should user experience (UX) design fit in the technical writer’s toolbox? Well, think about how your users experience your documentation:
Understanding how your users experience your documentation is understanding UX design – which can make or break your docs’ usability. As our guest and UX designer Autumn Hood describes it: “You can’t have good technical communication without good UX design.” In this episode, you’ll learn how to think like a UX designer so you can create an effective documentation experience for your users. The Show Notes: | |||
| Skill #3: Creating Just-in-Time Documentation | 09 May 2016 | 00:30:07 | |
Face it: sometimes, documenting software can be tricky. Not because we don’t understand the software – we get that. Nor because we can’t articulate it in layman’s terms – we’ve got that covered, too. But because feature guides – the traditional style of software documentation – isn’t enough to ensure your end users can find the information they need to accomplish a specific task. Enter just-in-time documentation: a new methodology of documentation that complements feature guides by creating task-oriented documents, as our guest Bri Hillmer describes it, “just in time, when the customer asks the question.” In this episode, you’ll learn about the power of just-in-time documentation and how you can apply it to your documentation today. The Show Notes: | |||
| Skill #2: Transitioning from Tech Writing to Marketing | 16 Mar 2016 | 00:23:14 | |
What’s the ultimate stereotype of technical writers? Easy: that once you begin your career as a technical writer, you’re caught in a documentation vortex. And worse – that there’s no way out. But just like all stereotypes, they’re meant to be broken. As communication experts, our skills – analyzing an audience; writing crisp, clear, concise copy – surpass documentation into an industry many technical writers like yourself once deemed “in someone else’s wheelhouse.” The industry: Marketing. In this episode, you’ll learn how your skills translate to marketing so you can – if desired – get out of the documentation vortex and transition into marketing. The Show Notes:
| |||
| Skill #1: Applying Empathy to Your Audience Analysis | 01 Mar 2016 | 00:22:23 | |
Once you’ve found your end-user, think about how you find his or her truest needs for the product or service. For many technical writers, it looks something like this: compile a series of fairly generic questions – “how old are you?”, “how familiar are you with the technology?” – and hope their responses unveil their needs. Sometimes it works; but other times, you’re left asking yourself, “What did I miss?” The answer is simple: Empathy. In this episode, you’ll learn how to apply empathy to your audience analysis so you can get greater insights on your end-users’ needs, and in turn, create more effective content. The Show Notes | |||
| Marrying skillsets and existential googling with Caity Cronkhite | 19 Mar 2021 | 00:36:12 | |
In this episode, I’m excited to be speaking to Caity Cronkhite, Seattle-based founder and CEO of Good Words LLC. We talk about her experience of starting up as a tech writer both in-house and freelancing, before starting and growing her own successful business in the technical writing industry, and the successes and struggles of operating Good Words LLC in these strange and unpredictable pandemic times. Additional topics: U-Haul montage; Something Big and Impactful; (not) going the way of the startup; nurturing your network; adult, painstaking colouring. Read the full transcript for this episode here. | |||
| How to Infiltrate a Hackathon in Iowa with Philip Kiely | 16 Feb 2021 | 00:46:23 | |
In such a complex and fast-moving industry as tech writing, it can be interesting to see how burgeoning tech writers get started - and become successful. Enter Philip Kiely, author of Writing for Software Developers and owner of PK&C, the world's smallest conglomerate. He graduated from Grinnell College in May 2020 with a degree in computer science, and has only gone onwards and upwards from there! This week I speak to Philip about being a new(-ish) entrant to the tech writing game, becoming a first-time author of a successful book, adventures during his time studying abroad in Budapest, Hungary, and how he managed to infiltrate a hackathon in Iowa during a blizzard! Read the full transcript for this episode. Show notes: | |||
| A Fond Farewell (Yet Warm Welcome!) | 03 Jan 2021 | 01:22:13 | |
After four exciting years hosting The Not-Boring Tech Writer—the podcast that gives listeners the skills to break the stereotype that technical writing is a boring career—I’ve passed the podcast along to longtime sponsor KnowledgeOwl, a knowledge base software company. This sobers me, admittedly: What began as a medium to connect with colleagues whom I’ve admired since university gradually become a resource for new and seasoned technical writers alike to learn the skills they need to break the stereotype that technical writing a boring career. Now, as I begin a new career, KnowledgeOwl—who, as you’ll learn in this episode, has a relentless commitment to supporting the technical writing—will ensure the philosophy you’ve impressively fostered through this podcast continues. In this episode, Chief Executive Owl at KnowledgeOwl Marybeth, joins the podcast to share her vision for the podcast. In addition, upcoming host and KnowledgeOwl employee Jerrard Doran joins to share how he’ll further the philosophy while adding his own unique approach. Thanks, all, for your support of The Not-Boring Tech Writer—and hope you enjoy this episode. | |||
| Skill #36: Creating Usability Tests for Your Organization | 03 Nov 2020 | 00:46:42 | |
Technical writers must ensure their help resources, such as documentation and video tutorials, are useful for their users. Therefore, they study language, design, and Support tickets—gathering all the context they need to ensure users can accomplish their task. But get this: Through feedback loops such as quizzes and interviews with subject matter experts, you can create usability tests that transform the way in which you measure the effectiveness of your documentation. That’s why in this episode, we have Mariana Moreira on the podcast: Technical Writer at Zup Innovation and Community Manager of Brazil’s budding technical comm community, Tech Writing BR. Joining us, as well is Jerrard Doran at KnowledgeOwl—longtime sponsor of The Not-Boring Tech Writer—to discuss usability tests from a knowledge base software company’s perspective, as well. In this episode, you’ll learn everything you need to know to begin creating usability tests for your organization. Show notes: | |||
| Skill #35: Understanding Basic Design Principles | 30 Sep 2020 | 00:40:30 | |
Technical communicators wield the power of plain language to ensure their readers find and understand the information they need to complete a task—no matter how complex. Basic design principles, such as alignment, contrast, and other principles you’ll learn in this episode, give your documentation that extra lift it needs to engage readers throughout your documentation. That’s why in this episode, we have Laci Kettavong on the podcast: Marketing and Member Coordinator at Stoke, a coworking space based in Denton, Texas—and also a former technical communicator in both industry and academia, deploying design principles for several different mediums. Joining us, as well is Jerrard Dorran at KnowledgeOwl—longtime sponsor of The Not-Boring Tech Writer—to discuss design principles from a knowledge base software company’s perspective, as well. In this episode, you’ll learn everything you need to know to begin using basic design principles in your documentation. Show notes: | |||
| Connecting permaculture and documentation with Liz Argall | 26 Jun 2025 | 00:45:52 | |
In this episode, I’m talking with Liz Argall, a writer I connected with at Write the Docs Portland 2025. We talk about working on open source projects, developing good qualitative metrics, her work with a permaculture nonprofit in Uganda, and the ways that being interviewed by a technical writer can make hidden expertise shine. — Liz and I presented in the same Lightning Talk session at Write the Docs Portland 2025 and subsequently discovered a shared love for spreadsheet tools, qualitative metrics, and permaculture. We discuss her work on Project Aria, a combination of hardware, software, and data collection geared toward solving the problems that augmented reality will need to address. Liz stresses the point of writing for poorly informed and/or sleep-deprived audiences. We also discuss the importance of qualitative metrics and some of Liz’s favorite qualitative metrics that help capture the story of the documentation, including impact and saving engineers’ and SMEs’ time. Liz also tells us about her involvement with Ngombor Community Development Alliance, a non-profit focusing on permaculture development in the West Nile region of Uganda. We also discuss how sometimes just showing up for something–including showing up to work on your docs–has far more impact than we realize. About Liz Argall: Liz Argall creates empowering documentation and processes; where you need it, when you need it. She’s a technical writer, program manager, author, and trainer who delivers humanizing, data informed, accessible, and technically complex projects for a range of organizations, from Fortune 500 companies to a community development organization in Uganda. In a past life, she was a professional artist talent scout and she’s still a professional member of SFWA (now called the Science Fiction and Fantasy Writers Association). She’s a graduate of Clarion Writers Workshop, has been critiqued by multiple New York Times best selling authors, and has critiqued the stories of multiple award winning authors, which is a long way of saying that she likes to give a good portfolio critique! Resources discussed in this episode:
—
Join the discussion by replying on Bluesky Contact Kate Mueller: Contact Liz Argall:
| |||
| Documentation as a creative endeavor with Nick Graziade | 12 Jun 2025 | 00:50:17 | |
In this episode, I'm talking with Nick Graziade, a technical writer and musician who approaches documentation as a creative endeavor. We explore how his early fascination with Lego instructions and synthesizer manuals shaped his philosophy that technical writing doesn't have to be dry or boring, but can be passionate and innovative work that adapts to different audiences and embraces impermanence. — Nick shares his two-part "villain origin story" that led him to technical writing. The first part involves his childhood fascination with Lego instructions, which taught him that visual documentation could guide complex building without narration. The second part comes from his music school experience with synthesizers, where he discovered that the best manuals—like those from Moog—don't just explain how to do something, but also why. This combination of visual clarity and deeper understanding became his template for approaching technical documentation. We dive deep into the concept of using different "grammars" for different audiences, drawing from Wittgenstein's language games. Nick emphasizes that effective technical communication requires understanding what assumptions you can make about your readers and adapting your language accordingly. We explore how consistency in style and formatting reduces cognitive load for users, and how deliberately breaking those patterns can create powerful contrast for important information like warnings or alerts. Throughout our conversation, Nick reflects on his philosophy of embracing impermanence in documentation. Rather than being frustrated by constant updates and revisions, he sees the evolving nature of technical writing as aligned with his Buddhist-influenced worldview. We discuss practical approaches to managing documentation workflows, including his use of quarterly revision cycles, just-in-time updates based on development sprints, and how he determines when something is "done enough" to move on to the next priority. About Nick Graziade: Nick is a Senior Technical Writer, instructional designer, knowledge management expert, musician, and philosopher from Upstate New York's Capital District. When not obsessing over the nuances of a web page's navigation sidebar, you can likely find him playing gigs as a professional bassist or practicing Japanese sword arts. Resources discussed in this episode:
—
Join the discussion by replying on Bluesky
| |||
| Kate sounds off on Write the Docs | 29 May 2025 | 00:26:51 | |
In this solo episode, I share an update on my content update progress. I also reflect on Sue Brandt’s interview (S3:E10) and on the Write the Docs Portland 2025 conference. — I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigation and UI changes that were rolled out in December. I updated an additional 50 articles since my last episode, taking my total to 507. 🎉Most of the updates this month were in our payment and plan-related documents, which needed to be updated for a new Billing page user interface and to include changes from migrating to a Merchant of Record. My velocity this month was lower thanks to teaching KnowledgeOwl’s Authoring 101 class and attending the Write the Docs Portland 2025 conference with Chad. Write the Docs is always a deeply inspiring conference for me, and this was my first time attending in person since 2019. This year, I even gave a lightning talk about dogs and docs, too! Much of the episode is spent reflecting on the six things I most love about Write the Docs, which include its support for first-time attendees and presenters, the flexibility and thoughtfulness of its design, and the amazing community of documentarians who form the backbone of this community. This year’s conference had a fantastic selection of talks and speakers, including several previous and upcoming podcast guests.
—
We love hearing your ideas for episode topics, guests, or general feedback: Join the discussion by replying on Bluesky Contact Kate Mueller: Contact KnowledgeOwl: | |||
| How to get hired as a tech writer with Sue Brandt | 15 May 2025 | 00:41:25 | |
In this episode, I’m talking with Sue Brandt, a former Director of Documentation who’d hired around 60 people when we recorded the episode. We discuss practical strategies for technical writing job applications, what hiring managers are really looking for in resumes and interviews, and how to stand out in today’s competitive job market. — Sue and I discuss various aspects of the tech writing job application process, including resumes, cover letters, and interviews. Sue, who has hired around 60 people throughout her career, emphasizes that enthusiasm is often a key differentiator for candidates. Throughout the episode, Sue shares practical tips based on her experience managing tech writing teams of up to 30 people, including ways to stand out as an applicant, how to handle situations where you may not have the exact technical skills in a job description but can demonstrate transferable skills and a willingness to learn, resume and portfolio best practices, how to honestly address gaps in employment, and more. The episode concludes with a discussion of career transitions and the importance of being open to learning new things. About Sue Brandt Sue was educated as a biologist, did postdoc research into marine microorganisms, and named 13 new species! She moved a little closer to the tech field when she worked with computer scientists on a bioinformatics project and found herself in the role of "translator" between computer scientists and biologists. Her tech writing career unofficially started when someone looked over her shoulder when she was job searching and said "You could do that.” Sue worked as a Technical Writer at a UK startup for 3 years, then moved to Denmark and worked at Microsoft for 13 years as a Programming Writer and then Developer Documentation Manager. She was always adamant that she didn't want to be a manager, but she was persuaded to try it and found out she loved it! She became Director of Documentation at Sitecore and managed 30 writers, editors, and developers working on 10 different products in 6 countries. — Contact The Not-Boring Tech Writer team: We love hearing your ideas for episode topics, guests, or general feedback: Join the discussion by replying on Bluesky Contact Kate Mueller: Contact Sue Brandt: Contact KnowledgeOwl: | |||
| Kate sounds off on knowledge sharing and docs stewardship | 01 May 2025 | 00:16:18 | |
In this solo episode, I share an update on my content update progress. I also reflect on Marcia Riefer Johnston’s interview (S3:E8) and on the idea of docs stewardship as opposed to docs ownership. — I’ve continued my work to update the KnowledgeOwl Support Knowledge Base to align with major navigation and UI changes that were rolled out in December. I updated an additional 91 articles since my last episode, taking my total to 457. 🎉 I also reorganized another three Features subcategories, taking me to the milestone of having updated half those categories using content type-inspired information architecture. I also relocated 12 mice from my basement. Marcia’s episode prompted a lot of reflection for me. Her infectious, unbridled enthusiasm for this work—from learning new tools to new domains— reminded me of all the reasons I love the craft of technical writing, and how thankful I am that for the last year I’ve largely “only” been doing technical writing. I also appreciated Marcia’s exhortations to share what you know because you never know what great things will come from sharing your knowledge. Too often, we don’t share what we know because we don’t think we know “enough” (whatever that is). But sharing knowledge is a gift to others. Thanks to a conversation with a friend, I’ve started to come around to the idea of docs stewardship rather than docs ownership. “Stewardship” comes from the Old English words for house and guard. Stewards originally managed estates for medieval lords. I extend this into the world of documentation (doesn’t “Guardian of the Docs” sound like an awesome way to describe what we do? Maybe a swag idea, too, non?). Most modern definitions of stewardship include the idea of “careful and responsible management of something entrusted to one’s care” (source), though they may also add sustainability, ethical use, or “a duty to protect and maintain assets which might be natural, financial, or informational” (source). Marcia’s observation that a lot of a tech writer’s job involves project and process management aligns with this approach, I believe. I explore some other ways I like this docs stewardship model and then draw a comparison between tech writers and gardeners. Resources discussed in this episode:
— Contact The Not-Boring Tech Writer team: We love hearing your ideas for episode topics, guests, or general feedback: Join the discussion by replying on Bluesky
| |||