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