Technical Writing — Show you Care


Found on the web:

"Next, we will then start coding. The first 
thing we should do is to..."

Technical writing may seem like a piece of cake — who can’t write a set of step-by-step instructions?

But it’s not that simple. A technical writer establishes a voice and personality for the piece, just like any other writer. That voice can be dry and machine-like, leaving it up to you to process the information in your own head, or personable and warm — right there with you as you go through the steps.

Upset teenage boy at computer

A technical writer needs an editor just like any other writer to avoid the mistakes in the example above. After looking at the same piece of writing for so long, and focusing on the technical instructions, an instruction that tells us ‘next we will’, ‘then start’, ‘the first thing we should do’ is easy to miss. This example is harmless — it’s good for a smile but screams to be improved. But, it shows how the language we use in instructional writing can get our end-user into trouble — or simply distract them from the task at hand.

Technical documents reflect on an organization’s professionalism, and on the writer’s own skill and subject matter knowledge. Technical documents show the organization’s focus on the customer when documents are written with the technical level of the end-user in mind, and written with a friendly, helpful attitude. Take pride people! Yes, someone will read every word!

If you feel like you’re wasting time by reading the whole article, you are reading the wrong thing. Step #1 Find content


“In fact, it doesn’t even matter if the content is consumed, as long as it’s shared. Reading doesn’t generate ad dollars. So whenever you hear a media pundit proclaim, “Long-form journalism is dead!” what they mean to say is “Long-form journalism isn’t lucrative.”
It’s not that people won’t read long-form content, it’s that the nature of digital publishing has seemingly removed any incentive to produce content that takes longer than eight seconds to consume.”

The dirty secret about online content and shrinking attention spans | Articles | Media Relations