Technical Writing Resources?

sthompson86

Good morning, I have recently encountered the need in my job to do more in depth technical/howto oriented writing. I can get the job done, but I would like to get better at it.

Just wondering if anybody has any recommendations on technical writing books or other resources.

Thank you.

tedjames

I have a degree in technical writing and worked for many years in that capacity. While I can't really recommend a current book (I studied technical writing in the 1980s). While there haven't been too many grammar-related breakthroughs in the past few decades, you can probably find some more current resources online, maybe through Amazon. There are plenty of great websites with free instruction as well.

If you're writing instructions, don't write paragraphs. Instead, write short sentences in a numbered list using active voice. People just want simple instructions on how to accomplish a task.

1. Do this.
2. Do that.
3. Do this.

You get the idea. If applicable, tell the user what to expect after each step:

1. Do this.

The following screen displays.
(Include screen capture.)

2. Do that.

You will be directed to the XXXXX menu.

Hope this helps. Just keep it clear and concise.

philz1982

If you want to see really bad technical writing that has slowly moved towards better technical writing, check out my blog in my signature. I've been working really hard on writing better. I would suggest you google Copy Writing. Some of the things mentioned by tedjames:

1) Clearly communicate, in short paragraphs with short sentences.
2) Layout the Cause, Action, Effect (e.g Your fat cause you eat to much. Eat Less. Lose weight)
3) Tell stories to engage and draw in the reader.

sthompson86

tedjames wrote: »

I have a degree in technical writing and worked for many years in that capacity. While I can't really recommend a current book (I studied technical writing in the 1980s). While there haven't been too many grammar-related breakthroughs in the past few decades, you can probably find some more current resources online, maybe through Amazon. There are plenty of great websites with free instruction as well.

If you're writing instructions, don't write paragraphs. Instead, write short sentences in a numbered list using active voice. People just want simple instructions on how to accomplish a task.

1. Do this.
2. Do that.
3. Do this.

You get the idea. If applicable, tell the user what to expect after each step:

1. Do this.

The following screen displays.
(Include screen capture.)

2. Do that.

You will be directed to the XXXXX menu.

Hope this helps. Just keep it clear and concise.

Thanks Ted - I try and make things as you mentioned, direct as possible.

sthompson86

philz1982 wrote: »

If you want to see really bad technical writing that has slowly moved towards better technical writing, check out my blog in my signature. I've been working really hard on writing better. I would suggest you google Copy Writing. Some of the things mentioned by tedjames:

1) Clearly communicate, in short paragraphs with short sentences.
2) Layout the Cause, Action, Effect (e.g Your fat cause you eat to much. Eat Less. Lose weight)
3) Tell stories to engage and draw in the reader.

Thank you - I will check it out.

tedjames

Check this out: https://www.google.com/?gws_rd=ssl#q=free+technical+writing+course