All week we here at the Cafe have been discussing how to reveal character through language. Put yourself in the reader\u2019s mind. What should the reader be told, what should the reader be allowed to infer, and what should the reader be assumed to know? A technical writer must also ask those questions, not to illuminate character, but to convey factual information.<\/p>\n
It comes down to trust, really, between reader and writer. You, as a writer, must create a space with your words in which trust can grow, in which the reader feels free to say to themselves, \u201cI don\u2019t know where this is going, but I\u2019ll be glad to get there.\u201d It\u2019s a difficult challenge, and an awesome responsibility.<\/p>\n
The vast majority of the documents produced by my bureau are written by our techies for the benefit of other techies. It is presumed that the reader has, or can easily obtain, the necessary context to make sense of the information. For most ordinary purposes, that is true. We don\u2019t need to explain every measurement, spell out every acronym (more than once), or describe the significance of the data. To do so would be patronizing and could actually damage the writer\u2019s credibility.<\/p>\n
However\u2026<\/p>\n
Some of our documents, arguably the most important ones, are not written for techies. They are written for the general public, or legislators, or for other members of our agency whose technical expertise lies in other areas. For these audiences, we must provide the context as elegantly and concisely as possible. We must educate them without either talking down to them or confusing them. Failure to do so can result in a loss of credibility for the entire agency, or worse, loss of funding.<\/p>\n
It\u2019s not easy, building a trust relationship with someone you\u2019ve never met, may never meet, and who may not even exist. Unlike bloggers, journalists, or novelists, it\u2019s rare for a technical writer to develop a following, and for credibility to accrete to the byline. The relationship has to be established anew with each document. The stuff I write becomes part of the state\u2019s permanent record [0], and it has to be right, first time, every time.<\/p>\n
[0] I wonder if this is what my teachers meant when they said, \u201cThis is going on your permanent record?\u201d<\/p>\n","protected":false},"excerpt":{"rendered":"
All week we here at the Cafe have been discussing how to reveal character through language. Put yourself in the reader\u2019s mind. What should the reader be told, what should the reader be allowed to infer, and what should the reader be assumed to know? A technical writer must also ask those questions, not to […]<\/p>\n","protected":false},"author":12,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[5],"tags":[1119],"class_list":["post-1554","post","type-post","status-publish","format-standard","hentry","category-mechanics","tag-technical-writing"],"_links":{"self":[{"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=\/wp\/v2\/posts\/1554","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=\/wp\/v2\/users\/12"}],"replies":[{"embeddable":true,"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1554"}],"version-history":[{"count":0,"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=\/wp\/v2\/posts\/1554\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1554"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=1554"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.confabulatorcafe.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=1554"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}