Category Archives: Technical Writing

The Technical Writer’s Struggle in Office Space

In the movie Office Space, Tom Smykowski (played by Richard Riehle) writes technical manuals for the software company. His job as a technical writer becomes a point of discussion in the film, particularly when he tries to justify his role in the company by explaining that he takes the specifications from the customers and brings them to the software engineers.

If you’re a technical writer, you’ll relate to Tom’s dilemma. For Tom the struggle wasn’t the nature of his job, rather how to explain the value of his writing activities during HR reviews. So how can you approach this?

Do you have a technical writer’s personality?

10 Signs you have a technical writer’s personality
If you’re thinking of moving into tech docs, here’s a list of things to consider.
There’s no priority to the items I’ve listed here. For me, these are some of the traits you’ll need to enjoy a career in technical writing.

Why AI is creating a growing demand for Technical Writers

If you’re considering a career in technical writing, specializing in AI documentation offers promising career opportunities. I’d recommend that you create 30-day plans to go deep into the technologies to give yourself and edge over other writers and carve out a lucrative career in this area. Here’s how to get started.

Checklist to Evaluate Technical Documentation Software

Identifying the right technical documentation software for your department can be overwhelming. To address this, the following checklist identifies some of the key criteria to consider when selecting technical documentation aka tech authoring software. The list is not exhaustive, but should give you a starting point to assess the products.

User Story – Writing Guidelines and Checklists

In this week’s technical writing tutorial, we look at how to write a user story. You can use these guidelines and checklists to refine your user stories, expand the material to help your readers understand the scenario, allow developers to code the requirement, and testers to ensure it meets the acceptance criteria. Let’s get started.

MadCap Flare: How to Update Stylesheets

In the Madcap world of Flare (yes, I promise never to say that again), you can use stylesheets to give your tech docs a real edge. For me, styles are one of the hidden secrets in Flare. So, if you plan to publish your tech docs to PDF, Web, or HTML5, a crash course in CSS […]