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