How To: Technical Writing

In an attempt to make my life easier, I’m going to start releasing a How To post every month. I’m going to learn about a specific topic, so you don’t have to! This month we’re going to discuss the topic of Technical Writing, using this article by Document 360.

What Is Technical Writing?

Technical writing is writing or drafting technical communication used in technical and occupational fields, such as computer hardware and software, architecture, engineering, chemistry, aeronautics, robotics, finance, medical, consumer electronics, biotechnology, and forestry. Technical writing encompasses the largest sub-field in technical communication. [Source]

In short, technical writing is a way to convey technical information to people. Details about a project, how to use a piece of software, etc.

How to Make Your Technical Writing Easy to Understand

Think of Your Audience

Clear communication, and being aware of your audience is a large part of writing. I mean, if you’re creating something for someone else, you want it to work best for them.

It will help to use images, and write in a way that helps people visualize what you’re trying to tell them, as some people are more visual thinkers.

Don’t Be Too Technical

You don’t want to assume that whoever’s reading your post knows exactly what you’re talking about. Most of the time, if they’re reading something online, it’s to learn more about it. It will help you and your reader if you present the information in a relaxed, conversational way.

Some people like straightforward, clear information. But I would wager to say most people enjoy more relaxed writing.

Get a Second, or Even Third Opinion

When you’re writing something, it’s always helpful to have a fresh set of eyes look over it. Partly to proofread it, but also to see how it flows.

If it’s too stiff. If there are any changes that would benefit it. Don’t underestimate the power of editing over, and over, and over. No one ever wants to do it, but it’ll help in the long run.

Other Resources

The article we used to create this blog post has quite a few other fantastic resources. We also have a few blog posts on our blog that lend well to Technical Writing: