The Not-Boring Tech Writer

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: 

• Chris Lam on The Not-Boring Tech Writer
• Bri Hillmer on The Not-Boring Tech Writer
• Alexander Yant on LinkedIn

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: 

• Margaret on LinkedIn
• Margaret on Twitter
• Bri Hillmer on creating just-in-time documentation

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: 

• Write the Docs
• Write the Docs Slack
• Learning GitHub course on LinkedIn
• Skill #14: Contributing to Open-Source Projects
• Tad on GitHub
• Tad on LinkedIn

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: 

• Tom’s site I’d Rather Be Writing
• Tom’s API documentation course
• Tom’s latest podcast on API documentation
• Write the Docs
• Write the Docs Slack
• SendGrid API documentation
• Tom on Twitter

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: 

• how to position yourself in the user experience process
• how to practice your contextual help writing 
• Where to find the best examples of contextual help

Show Notes: 

• Microcopy: The Complete Guide
• Skill #4: Understanding UX Design
• WalkMe
• Kacy Ewing on LinkedIn
• Kacy Ewing on Twitter

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:

• how to find your niche as a writer
• how to market that niche to prospective clients
• how to use your niche to win big clients

Show Notes: 

• John on Twitter
• John on LinkedIn
• Content DNA by John Espirian
• Pen Portraits by John Espirian
• Creating a Human Connection in Your Documentation
• Branding Your Work

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:

• Where to find a tribe of technical writers
• How to use your existing skills to transition into technical writing
• How to ramp up your skills to find your first gig

Show Notes: 

• MadWorld Conference
• Write the Docs
• Write the Docs Slack
• Write the Docs Job Board
• Write the Docs Meetups
• Society for Technical Communication
• I’d Rather Be Writing 
• I’d Rather Be Writing API Documentation course
• Peter Gruenbaum courses on Udemy
• Skill #14: Contributing to Open-Source Projects
• Chad on Twitter
• Chad on LinkedIn

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:

• which detective skills are most useful for technical writers
• how to ramp up those skills
• how detective skills can help you transition into other fields within a software company

Show Notes: 

• Michal and Pawel on The Not-Boring Tech Writer
• Jamie Roddy on LinkedIn
• True Detective
• Guy Noir: Radio Private Eye

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

• how to find prospective mentees
• how to foster a relationship with mentees
• and how mentoring can boost your own technical writing career.

Show Notes: 

• John on Twitter
• John on Linkedin 
• Write the Docs meetups
• Write the Docs Slack
• STC

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

• How content marketing differs from technical writing
• How content marketers succeed
• And how to use your existing skills to transition into technical writing

Show Notes: 

• Zenreach blog
• Airtable blog
• Drift blog
• Chad’s Scary Thoughts podcast
• Chad on Twitter