Monday, April 6, 2009

Writing Technical Instructions By Kyle Ramos

When writing instructions there are a few things you have to take into perspective. Before you start you have to keep in mind the average audience and the audience’s average technical knowledge. Then you have to avoid technical jargon, because most average people will not understand the same lingo. Also avoid undefined acronyms and do not use 2 different words for the same thing.
Now I will tell you how to write technical instruction. When writing instruction you want to use the simplest language possible. You also want to write in the form of commands. From one command to another addressing each step clearly to your audience this makes instructions less wordy and easier to follow. Be careful that when you are trying to be simple that you don’t cut out necessary item which will then make your instructions unclear. Like when it is necessary to let glue dry, do not say “Let the glue dry” but instead say “Let the glue dry for 30 minutes at room temperature” this is more precise. If you follow these simple guidelines you will be able to write great instructions that anyone can follow.

5 comments:

  1. Dear Mr. Ramos;

    I found your blog to be helpful and informative. I particularly agree with you that simple language is the best way to communicate with the majority of your audience.

    Sincerely;
    Eusebio Moreno.

    ReplyDelete
  2. Kyle,

    You did a great job on describing how to write technical instructions. I agree that it is very important to take into consideration that people come from different cultures and aren't always familiar with slang and jargon.

    ReplyDelete
  3. Kyle, nice job. I was unaware of all of the specifics when writing technical instructions. This will be vital information in the future when working at a job. Knowing these specific tips will help one do a great job as well as keep their job

    ReplyDelete
  4. Great job. I agree you have to use simple language when explaining instructions. Try to include a visual next time.

    ReplyDelete
  5. I like your example about glue. You need more visuals and more white space.

    ReplyDelete