Most PR execs aren’t scientists, programmers or engineers.

Heck, most of us went right into a language-based area as a result of we aren’t that good at math.

However in your profession, there’ll possible come a time when it’s a must to clarify a posh, technical product or course of to a gaggle of laymen.

Scary, isn’t it?

However what makes for good technical writing are the identical issues that make for good writing total: readability, simplicity and protecting your viewers in thoughts. Mix that with a couple of tips from the smarties at Stanford Engineering from Ragan Coaching’s library and also you’ll be nicely in your strategy to writing technical materials that is sensible to everybody.

Keep away from ‘fancy phrases’

Should you’re writing one thing that’s already sophisticated, give your readers a break by making the remainder of the language round it so simple as attainable. For instance, Stanford recommends utilizing “discover out” as a substitute of “verify,” “start” as a substitute of “start,” and that outdated favourite, “use” as a substitute of “make the most of.”

You may nonetheless use technical phrases if you happen to’re certain that your entire viewers will perceive them. Should you aren’t certain, Stanford recommends utilizing these strategies to raised clarify:

• Use a synonym: “reminiscence” as a substitute of “RAM.”
• Describe the time period: “RAM permits your laptop to run extra rapidly and effectively.”
• Evaluate the time period with a typical idea: “RAM is like having a big desk with quite a few drawers for storage. You may rapidly and effectively entry your information at a second’s discover.”
• Outline the time period: “RAM, or random entry reminiscence, is one sort of laptop information storage programs. It permits your laptop to rapidly and effectively entry information.”

Transfer from knowns to unknowns

Regardless of how advanced the subject you’re writing about, you’ll be able to most likely tether new info to one thing the reader already is aware of. Drawing from “Rhetorical Grammar” by Martha Kolln and Loretta Grey, Stanford recommends starting with a bit of knowledge that readers already is aware of earlier than flowing logically into one thing new. It is a sample readers subconsciously perceive and can assist them take in the brand new.

• Earlier than: X has developed fourth-generation (4G) cellular phone expertise (new data). To help larger information charges for non-voice communication (new data), Y is utilizing 4G cellular phone expertise (identified data).
• After: X has developed fourth-generation (4G) cellular phone expertise (new data). Y is utilizing this (4G) expertise (identified data) to help larger information charges for non-voice communications (new info).

Issues to cut back or eradicate

Maintain the general copy movement as clear as attainable so the concepts can converse for themselves. To that finish, you’ll be able to cut back these twisty constructions when attainable:

• Imprecise pronoun references
• Extreme particulars
• Lengthy strings of nouns
• Passive voice
• Nominalizations (e.g., utilizing “prevalence” as a substitute of “happen”)
• Pointless prepositional phrases

Depend on your material consultants, simplify your copy and also you’ll don’t have anything to worry from technical writing.

For extra of Stanford’s Ideas, be part of Ragan Coaching. 

COMMENT