Their names are never found on the covers of their manuals. It’s a profession no one ever thinks about. You’d think that a manual just appears out of thin air, right? It probably rolls off the assembly line, just like the device it was made for. So who actually writes these things? It can’t be that hard – you simply write down where the button is to turn on the machine, don’t you?
Writing a manual is one of the jobs of a technical writer
Contrary to what you might think, writing a manual is not a simple task. Well, maybe for a device with only an on/off button. But what about that infrared heater you can configure remotely with your smartphone? A manual is a complex interplay of images, tables, graphs and text. It ensures that the user can properly operate an appliance or a machine, or can properly understand and manage a complex set of processes. The stakes are sometimes high: some machines can be lethal if operated improperly. And if not, the manual still affects the user experience of its reader. Who hasn’t attempted to assemble a cabinet while trying to decipher incomprehensible instructions? In short: the work of the technical writer is extremely important!
Writing? Let’s get to know the product first!
First and foremost, a technical writer can write well. They know better than anyone how to write about complex topics in such a way that an average reader with average linguistic skills can understand. Second, but no less important, is technical knowledge. You do not need to be an engineer, but a healthy interest in technical subjects is essential. After all, you have to do quite a bit of research before you start writing.
This is what the life of a technical writer looks like: you receive an assignment to, for example, write the manual for a charging point . You first start by researching how that device works. You talk to the manufacturer or the designer. You receive a detailed explanation of how the charging point is constructed, what its specifications are, how to operate it and what to beware of to ensure safety. You interrogate the client down to the finest details.
Lonely work? Not at all! Collaboration is a must for a technical writer.
Alright, you have your information. Now you have to organise it. Putting together the info that belongs together. You create modules: specifications, installation, operation, malfunctions, safety. But still you cannot start writing yet. You should first consult with the graphic designer or technical illustrator responsible for the images and graphics. After all, image and text need to be properly coordinated. Together with your colleagues in graphics, you come up with a draft of the manual.
Finally, you try to put yourself in the end user’s shoes. “What would I want to know first?”, you ask yourself, “and where would I look for information about the Wi-Fi connection ?”
A technical writer gets to all kinds of places
The first part of the week you were mainly occupied with the charging point. Now you have an appointment at a brewery, as there are a number of processes that must be documented. You have to understand everything in such a way that you can explain it to someone else. Listening, taking notes, asking questions, remembering all the details. Then the next day, you might be interviewing someone from the military to investigate how to service a truck. You translate their explanation into instructions for mechanics. While you were in the shoes of a charging station user before, now you’re suddenly seeing through the eyes of a military vehicle mechanic. At the end of the week, you have a moment of ‘quiet’. Finally time to write! That manual for the charging station needs to be finished, the brewing processes need to be written down, and you start working on the instructions for the military truck. So plenty to do before the Friday afternoon drinks! (Wasn’t it your turn to get the snacks?)
Your name is never mentioned on the covers of your masterpieces. But you write a lot of them during your career. You are invisible yet indispensable.
Technical writers are often thought of as sitting in an office tapping away on a keyboard all day. That writing manuals is a boring job because you always write the same things. A look into the real life of a technical writer shows quite the opposite. Makes sense: not every manual is the same. Not every device is the same, and manuals are needed for much more than just machinery. Technical writers deal with a multitude of topics. They work on a wide variety of content every day, on paper and digitally. They stroll through ports, farms, schools and factories. They talk to safety experts, graphic designers, engineers, machine builders and technical illustrators. They write for consumers, installers, maintenance engineers, construction personnel and machinists. What do you mean, a boring job?
Foxiz is looking for someone like you!
Do you want to make people happy with a crystal-clear manual or instruction? Do you like variety and delving into new subjects? Do you have a healthy interest in technology and a good grasp of the Dutch language? Then get in touch with Foxiz. We have plenty on offer for someone with your skills!
How can we help?
Are you an engineer and have you become convinced of the usefulness of a well-written manual? Can you explain perfectly how your machine works, but do you have trouble writing it all down? And do you like personal consultation with someone who can describe in detail what you mean? Then get in touch with Foxiz too. Crystal-clear technical documentation is our speciality!