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:
- where technical writers may currently miss the mark in their writing
- how technical writers can use cognitive science to make their writing more interesting
- small steps technical writers can take today to make their writing more interesting.
Show Notes:
What is The Not-Boring Tech Writer?
Some people hear the phrase "technical writing" and think it must be boring. We're here to show the full complexity and awesomeness of being a tech writer.
This podcast is for anyone who writes technical documentation of any kind, 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—there's a place for you here.
Each month, we publish two episodes: an interview with an amazing guest focusing on useful skills or tools that can help you improve your tech writing skills, and a behind-the-scenes solo episode with host Kate Mueller about what she’s working on, struggling with, or thinking about in her daily tech writing life.
The Not-Boring Tech Writer is generously sponsored by KnowledgeOwl, knowledge base software built for people who care, by people who care.