A Guide to Technical Writing
Using an integrated controller, the manufacturer was able to reduce overall operating costs in the facility while maintaining a high quality product and ensuring that employees are safe.
What?
For most people, this sentence does not make any sense. For those in the field of automation controllers, this is common knowledge. To be an effective technical writer, this sentence needs to be translated into lingo that anyone walking down the street would be able to interpret and understand. 
Easier said than done. Technical writing is perhaps one of the most difficult writing types that exists because it is difficult to find a "good" translation of technical information. However, following a few easy steps will ensure that your readers aren't left with question marks in their eyes.
Know your subject. Common sense would say that writers would know and understand what they are writing about. Often times, deadlines are too short to provide ample time for research. Without understanding what the topic, the piece will most likely sound like an engineer wrote it. This is not what writers want. Using the example above, it would be imperative for the writer to understand what a controller is and does, and how it affects manufacturing facilities. Researching companies or recent industry news is a great way to learn more about the subject.
Use primary research. Interviewing people in the field is a great way to expand your knowledge about the subject, and often times, will provide the content for the article or writing piece. Although an interview via email (send questions to interviewee to answer on their own time) is effective, its highly beneficial to conduct the interview via phone or in person. That way, when things are brought up that you are not familiar with, the person you are interviewing can provide a clear, concrete definition. Often times, they can translate it into everyday language and provide a compelling example. For instance, it when discussing the use of controllers in manufacturing facilities, it would be useful to know what is meant by "integrated" and how this differs from other controllers.
What?
For most people, this sentence does not make any sense. For those in the field of automation controllers, this is common knowledge. To be an effective technical writer, this sentence needs to be translated into lingo that anyone walking down the street would be able to interpret and understand.
Easier said than done. Technical writing is perhaps one of the most difficult writing types that exists because it is difficult to find a "good" translation of technical information. However, following a few easy steps will ensure that your readers aren't left with question marks in their eyes.
Know your subject. Common sense would say that writers would know and understand what they are writing about. Often times, deadlines are too short to provide ample time for research. Without understanding what the topic, the piece will most likely sound like an engineer wrote it. This is not what writers want. Using the example above, it would be imperative for the writer to understand what a controller is and does, and how it affects manufacturing facilities. Researching companies or recent industry news is a great way to learn more about the subject.
Use primary research. Interviewing people in the field is a great way to expand your knowledge about the subject, and often times, will provide the content for the article or writing piece. Although an interview via email (send questions to interviewee to answer on their own time) is effective, its highly beneficial to conduct the interview via phone or in person. That way, when things are brought up that you are not familiar with, the person you are interviewing can provide a clear, concrete definition. Often times, they can translate it into everyday language and provide a compelling example. For instance, it when discussing the use of controllers in manufacturing facilities, it would be useful to know what is meant by "integrated" and how this differs from other controllers.
- Learn how to technical write