{"id":3115,"date":"2012-08-28T11:17:41","date_gmt":"2012-08-28T16:17:41","guid":{"rendered":"http:\/\/www.encoretechresources.com\/insights\/?p=3115"},"modified":"2012-10-03T09:46:31","modified_gmt":"2012-10-03T14:46:31","slug":"your-aim-enlightenment-not-punishment","status":"publish","type":"post","link":"http:\/\/www.encoretechresources.com\/insights\/2012\/08\/28\/your-aim-enlightenment-not-punishment\/","title":{"rendered":"Your Aim: Enlightenment, Not Punishment"},"content":{"rendered":"

We were browsing the web for ideas and came upon a post on the Accidental Remediation blog<\/a> by Short Geologist. All we can discover about Short Geologist is that she’s a woman, but from her post anyway, a wise one.<\/p>\n

\"\"<\/a>SG has “a mania for clear, concise technical writing.” How do you get to that exalted state \u2013 a producer of clear, concise technical writing? Remember one thing, SG advises: “This isn’t high school, where you’re trying to pad your 11th-hour essay to fit the word count. Nobody cares how big your words are \u2013 and if they’re too big, perhaps it’s time to abbreviate. Remember, you’re writing to communicate, not punish the reader!”
\n
\nThat’s exactly it, all you need to know about good technical writing, or any other writing for that matter. You’re writing to communicate, not to punish the reader. Padding, cumbersome sentences or paragraphs, run-on streams of words \u2013 they’re not that hard to spot. Once you remember that your job is to communicate, not to punish the reader.<\/p>\n

When I was a freshly hired general assignment reporter in Philadelphia, I had a night city editor who had a red pencil and used it liberally on my copy, too much so, I thought at first. But Bill Grover was a teacher as much as he was an editor. He explained kindly and patiently why I didn’t need all those extra words and phrases to tell a clearcut story. Oh, and an accurate one, too \u2013 that was foremost. <\/p>\n

Once you adopt the frame of mind that you’re not writing to challenge your readers, or subject them to a detection ordeal, you’re a long way toward producing clearly rendered, effective material. <\/p>\n

“Not everyone shares my mania for clear, concise technical writing,” SG acknowledges. But if you want to remain a technical writer and become increasingly valued as one, you’ll cultivate just such a bent. It’s not that hard, once you recognize that you’re getting to “love thwacking through the clutter to edit a mess into something that is readable.” Another felicitous phrase from SG, to whom we’re indebted today. Thwack on! \u2013 Doug Bedell<\/em> <\/p>\n","protected":false},"excerpt":{"rendered":"

We were browsing the web for ideas and came upon a post on the Accidental Remediation blog by Short Geologist. All we can discover about Short Geologist is that she’s a woman, but from her post anyway, a wise one. SG has “a mania for clear, concise technical writing.” How do you get to that […]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,5],"tags":[],"class_list":["post-3115","post","type-post","status-publish","format-standard","hentry","category-communication","category-the-writing-life"],"aioseo_notices":[],"_links":{"self":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3115"}],"collection":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/users\/7"}],"replies":[{"embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/comments?post=3115"}],"version-history":[{"count":15,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3115\/revisions"}],"predecessor-version":[{"id":3228,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/3115\/revisions\/3228"}],"wp:attachment":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/media?parent=3115"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/categories?post=3115"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/tags?post=3115"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}