{"id":4231,"date":"2014-10-20T11:55:53","date_gmt":"2014-10-20T16:55:53","guid":{"rendered":"http:\/\/www.encoretechresources.com\/insights\/?p=4231"},"modified":"2014-10-20T12:00:16","modified_gmt":"2014-10-20T17:00:16","slug":"a-tech-writers-priority-striving-to-be-clear","status":"publish","type":"post","link":"http:\/\/www.encoretechresources.com\/insights\/2014\/10\/20\/a-tech-writers-priority-striving-to-be-clear\/","title":{"rendered":"A Tech Writer’s Priority: Striving to be Clear"},"content":{"rendered":"

\"eggs-unhappy\"<\/a><\/p>\n

When communication doesn’t work, becomes too dense or defiant, who’s at fault? Why, \u00a0you’ll say, the technical writer who created the offending\u00a0material. Could well be. Yet Mark Baker on a\u00a0Tech Writer Today post<\/a>, says the reader, as well, has a role to play\u00a0in coping with\u00a0printed material. But, definitely, that’s not to let the writer off the hook.<\/p>\n

“The curse of knowledge is, of course, a real and serious matter,” Baker writes. “And a good writer is certainly one who is aware of, and able to compensate for, the curse of knowledge, at least to a degree. But the problem with blaming the failure of communication on the curse of knowledge alone is that it leads to the expectation \u2013 which (Stephen) Pinker (in a cited New Yorker essay) explicitly states \u2013 that the cure is ‘to explain the jargon, or spell out the logic, or supply the necessary detail.'”<\/p>\n

Of course, a technical writer should be as accessible as possible to his or her readers. But the cure\u00a0for\u00a0dense writing, Baker argues, isn’t simply more words in the presumed interest of clarity. It’s to expect a reader to make some effort to understand what you have tried to present, provided<\/em> that<\/em> you, the writer, have indeed tried diligently to be clear. Due diligence becomes the key.<\/p>\n

Baker advises technical writers that “One of the most important things to remember when providing such resources is that the reader’s goal is not to understand what you have written. A meeting of the minds is not what the reader has in mind when they crack open a technical manual. Fully understanding the contents of the writer’s mind is not what the reader is aiming for. Rather, their aim is to understand something useful about the real world.”<\/p>\n

That calls, perhaps a bit more simply, for a technical writer to approach his or her material in the spirit of empathy, or walking in a\u00a0reader’s shoes. Before tackling the material, a technical\u00a0writer, like all writers, \u00a0should be thinking, “Now, who will be reading this, for what purpose?” You’d think that would be self-evident for instructions to a shared workplace or the equipment therein. But not really. People, even colleagues, come to writing from all sorts of backgrounds and levels of experience.<\/p>\n

You’ve got, first, to think clearly about “What am I trying to get across here, and what’s\u00a0the most accessible way to do it?” Not simply plunge into the instructional task, even if you\u00a0face\u00a0some sort of deadline\u00a0for completing it.<\/p>\n

Stepping into\u00a0a reader’s shoes is \u00a0mandatory for any sort of successful writing, technical instructions included. With that done, instructions become guidance, and who doesn’t appreciate effective guidance? \u2013 Doug Bedell \u00a0\u00a0<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"

When communication doesn’t work, becomes too dense or defiant, who’s at fault? Why, \u00a0you’ll say, the technical writer who created the offending\u00a0material. Could well be. Yet Mark Baker on a\u00a0Tech Writer Today post, says the reader, as well, has a role to play\u00a0in coping with\u00a0printed material. But, definitely, that’s not to let the writer off […]<\/p>\n","protected":false},"author":7,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[8,3],"tags":[],"class_list":["post-4231","post","type-post","status-publish","format-standard","hentry","category-communication","category-technology"],"aioseo_notices":[],"_links":{"self":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/4231"}],"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=4231"}],"version-history":[{"count":13,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/4231\/revisions"}],"predecessor-version":[{"id":4245,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/posts\/4231\/revisions\/4245"}],"wp:attachment":[{"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/media?parent=4231"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/categories?post=4231"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/www.encoretechresources.com\/insights\/wp-json\/wp\/v2\/tags?post=4231"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}