{"id":3169,"date":"2020-05-29T15:23:16","date_gmt":"2020-05-29T19:23:16","guid":{"rendered":"http:\/\/blog.daed.com\/?p=3169"},"modified":"2024-07-11T10:59:16","modified_gmt":"2024-07-11T14:59:16","slug":"why-you-need-technical-writers","status":"publish","type":"post","link":"https:\/\/blog.daed.com\/?p=3169","title":{"rendered":"Why Technical Writing is Essential"},"content":{"rendered":"

This week, I voted by mail for the first time for the Pennsylvania Primary Election. I\u2019ve always enjoyed voting in person for a variety of reasons, but as a type 1 diabetic in the midst of a pandemic, caution won over. The process of requesting my ballot was pretty simple and easy to do, as was filling out the ballot itself. So I was really surprised and disappointed when I saw how badly designed the instructions were that came with it.\u00a0(scroll down for an update on this article based on the General Election Ballot instructions)<\/span><\/p>\n

I\u2019m actively involved in the creation of guidance documents that establish best practices for medical device manufacturers to write instructions for equipment that\u2019s used by patients in their everyday lives. In other words\u2014how to write instructions so that a tween can figure out their insulin pump, a stressed out and exhausted parent can successfully use a SIDS monitor, or a coach can safely use an EpiPen if a player goes into anaphylactic shock. So, I’m sensitive to poorly written instructions and\u00a0notice these things a bit more.\u00a0<\/span><\/p>\n

But still: these instructions were <\/span>BAD<\/b>. Let me count the ways:<\/span><\/span><\/p>\n

Incorrect Content<\/b><\/span><\/h2>\n

To start off with, the content was \u2026 not exactly correct.\u00a0<\/span><\/p>\n

The instructions said that I needed to return the ballot in the envelope that was marked \u201cOfficial Mail In\/Absentee Ballot\u201d. But my envelope was labeled \u201cOfficial Election Ballot.\u201d\u00a0<\/span><\/p>\n

The instructions also told me that any ballot received with an unsigned \u201cElector’s Declaration\u201d on the envelope would be rejected. But there wasn\u2019t an \u201cElector’s Declaration\u201d on my envelope\u2014there was a \u201cVoter’s Declaration.”\u00a0<\/span><\/p>\n

Were either of these errors huge? No, they were relatively minor ones and they didn\u2019t prevent me from voting. They were, however, quite frankly, stupid mistakes that wouldn\u2019t have been made by a good technical writer and mistakes that should have been caught by any decent proofreader. The fact that these minor errors made it to print is emblematic of larger issues such as a lack of care or consideration for the people using this ballot.<\/span><\/p>\n

Again, these were dumb mistakes that I easily overcame\u2014but how many people might have been thrown off by them?<\/span><\/p>\n

Complex and Confusing Directions<\/b>\u00a0<\/span><\/span><\/h2>\n

Beyond the lack of proofreading, the instructions were also badly designed and overly complex.\u00a0<\/span><\/p>\n

The average American adult reads at a 9th-grade level. For instructions, most guidelines suggest writing at a 6th-\u00a0or 7th-grade\u00a0level to ensure comprehension. What does this mean in practice? It means that sentences should be short, direct, and written in a declarative voice. (Like this one.)<\/span><\/span><\/p>\n

I ran some readability statistics: the mail-in ballot instructions were written at an 11th-grade\u00a0reading level, and the instructions averaged over 20 words per sentence. They also relied on a lot of passive voice, which is harder to understand, even for native English speakers. And they grouped sentences together in large, hard-to-read blocks of text, which brings us to…<\/span><\/span><\/p>\n

Unfriendly and Inconsistent Formatting<\/b><\/span><\/h2>\n

There was <\/span>no<\/b> use of white space to help segregate sections. But formatting that made the text harder to read was abundant!\u00a0<\/span><\/span><\/p>\n

Thirty percent of the text was in <\/span>bold font face<\/b>. Thirty percent.\u00a0<\/span><\/span><\/p>\n

Sixteen percent was in ALL CAPS (which is harder to read than is mixed case), and 9% was <\/span>underlined<\/u><\/span>.\u00a0<\/span><\/span><\/p>\n

Apparently, 7% of the text must have been really important because it merited <\/span>ALL THREE FORMATTING OPTIONS<\/u><\/b> (spoiler alert: that text wasn\u2019t all that important). I\u2019m surprised they didn\u2019t throw in some <\/span>italics<\/span><\/i> just for the fun of it.\u00a0<\/span><\/span><\/p>\n

But there\u2019s more! The linear steps to vote and return the ballot\u2014do this, then do this, then do that\u2014 were written in paragraph format, as I noted above. When you think of a list of instructions, what do you think of? Perhaps something like this?\u00a0<\/span><\/p>\n

    \n
  1. Read the instructions for your mail-in ballot<\/span><\/li>\n
  2. Notice how irredeemably bad they are<\/span><\/li>\n
  3. Write a blog post about badly designed instructions<\/span><\/li>\n<\/ol>\n

    Hint: the steps to vote would have been much easier to follow as a list of numbered steps.\u00a0<\/span><\/p>\n

    The instructions were also fully justified (aligned on both left and right margins)\u2014but left-aligned text is easier to read. And with left-aligned text as the default setting in most word processing programs, that means they <\/span>chose<\/b> to make them harder to read.<\/span><\/span><\/p>\n

    Accessibility<\/b><\/span><\/h2>\n

    The font size for the instructions appears to have been an 11-point font but the majority of mail-in voters, at least prior to the pandemic, are older and are more likely to need reading glasses. So, a larger font would have been more appropriate.\u00a0<\/span><\/p>\n

    And finally, though everything else in that packet was printed on white paper, the instructions were inexplicably printed on colored paper\u2014mine was on gray, and I\u2019ve heard of others that were on blue. Maybe the intention was to draw attention to the instruction paper? But by printing black text on a gray (or blue) background, the contrast between the font and paper was reduced, also making it harder to read, especially for older voters.\u00a0<\/span><\/p>\n

    In Conclusion…<\/b><\/span><\/h2>\n

    I\u2019ve argued in the past that <\/span>not everyone can be a designer<\/span><\/a>. It should be pretty obvious that not everyone can write instructions either. If you want to make sure your product or service\u2014whatever you are writing instructions for\u2014 is successful, you must<\/strong> use skilled technical writers.<\/span><\/span><\/p>\n

    \n

    Here are the instructions that I received, and how I would have rewritten them.<\/span><\/p>\n

    \"The<\/a>.\"How<\/a><\/p>\n

    \n

    Update for the General Election 2020<\/span><\/strong><\/h2>\n

    Well, here we are in October. We are still in the midst of a pandemic; so, once again, I opted to vote by mail. I’m pleased to say that some<\/em> of the issues that I detailed with the Primary Election mail-in ballot instructions have been resolved. They fixed the content that was wrong and the instructions I received were on white paper. But the formatting is still dreadful, and the instructions are not only still complex and confusing … they’ve gotten even worse.\u00a0<\/span><\/p>\n

    Most perplexing are the two opening sentence of the instructions, the first of which states that my ballot must be received by the Elections Division by 8 P.M. on Election Day (which is a Tuesday). Okay, seems simple enough … except that the second sentence states that as long as my ballot is received by that Friday it will be counted if it was post marked by Election Day. So, Tuesday is the deadline. Nope, wait, Friday is the deadline. Um?\u00a0<\/span><\/p>\n

    And some of the instructions that were included in the Primary Election Ballot Instructions that seem like they still apply to the General Election Ballot, are no longer included, like how to return your ballot via Fed Ex, DHL, UPS, or Designated Agent, which may be a problem for people with a disability.\u00a0<\/span><\/p>\n

    Once again, here are the instructions I received, and how I would have rewritten them (using only the content included this time):<\/span><\/p>\n

    \"The<\/a>\u00a0\"How<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

    This week, I voted by mail for the first time for the Pennsylvania Primary Election. I\u2019ve always enjoyed voting in person for a variety of reasons, but as a type …<\/p>\n","protected":false},"author":10,"featured_media":3529,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[6,3],"tags":[186,187],"yoast_head":"\nWhy Technical Writing is Essential - daed.com<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/blog.daed.com\/?p=3169\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Why Technical Writing is Essential - daed.com\" \/>\n<meta property=\"og:description\" content=\"This week, I voted by mail for the first time for the Pennsylvania Primary Election. I\u2019ve always enjoyed voting in person for a variety of reasons, but as a type ...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/blog.daed.com\/?p=3169\" \/>\n<meta property=\"og:site_name\" content=\"daed.com\" \/>\n<meta property=\"article:published_time\" content=\"2020-05-29T19:23:16+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2024-07-11T14:59:16+00:00\" \/>\n<meta property=\"og:image\" content=\"http:\/\/blog.daed.com\/wp-content\/uploads\/2020\/05\/TorturedPath.png\" \/>\n\t<meta property=\"og:image:width\" content=\"1000\" \/>\n\t<meta property=\"og:image:height\" content=\"817\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/png\" \/>\n<meta name=\"author\" content=\"Daedalus Team\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Daedalus Team\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"6 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/blog.daed.com\/?p=3169#article\",\"isPartOf\":{\"@id\":\"https:\/\/blog.daed.com\/?p=3169\"},\"author\":{\"name\":\"Daedalus Team\",\"@id\":\"https:\/\/blog.daed.com\/#\/schema\/person\/f08aac4ae63cbed0fffa61088919d15f\"},\"headline\":\"Why Technical Writing is Essential\",\"datePublished\":\"2020-05-29T19:23:16+00:00\",\"dateModified\":\"2024-07-11T14:59:16+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/blog.daed.com\/?p=3169\"},\"wordCount\":1159,\"publisher\":{\"@id\":\"https:\/\/blog.daed.com\/#organization\"},\"keywords\":[\"Instructions for use\",\"Technical writing\"],\"articleSection\":[\"design thinking\",\"product development\"],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/blog.daed.com\/?p=3169\",\"url\":\"https:\/\/blog.daed.com\/?p=3169\",\"name\":\"Why Technical Writing is Essential - daed.com\",\"isPartOf\":{\"@id\":\"https:\/\/blog.daed.com\/#website\"},\"datePublished\":\"2020-05-29T19:23:16+00:00\",\"dateModified\":\"2024-07-11T14:59:16+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/blog.daed.com\/?p=3169#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/blog.daed.com\/?p=3169\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/blog.daed.com\/?p=3169#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/blog.daed.com\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Why Technical Writing is Essential\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/blog.daed.com\/#website\",\"url\":\"https:\/\/blog.daed.com\/\",\"name\":\"daed.com\",\"description\":\"research, design, and engineering thinking\",\"publisher\":{\"@id\":\"https:\/\/blog.daed.com\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/blog.daed.com\/?s={search_term_string}\"},\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/blog.daed.com\/#organization\",\"name\":\"daed.com\",\"url\":\"https:\/\/blog.daed.com\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.daed.com\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/blog.daed.com\/wp-content\/uploads\/2019\/10\/White_Daedalus.png\",\"contentUrl\":\"https:\/\/blog.daed.com\/wp-content\/uploads\/2019\/10\/White_Daedalus.png\",\"width\":5249,\"height\":745,\"caption\":\"daed.com\"},\"image\":{\"@id\":\"https:\/\/blog.daed.com\/#\/schema\/logo\/image\/\"}},{\"@type\":\"Person\",\"@id\":\"https:\/\/blog.daed.com\/#\/schema\/person\/f08aac4ae63cbed0fffa61088919d15f\",\"name\":\"Daedalus Team\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/blog.daed.com\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/524207b1dc467ee81cafe2cc979aa823?s=96&d=mm&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/524207b1dc467ee81cafe2cc979aa823?s=96&d=mm&r=g\",\"caption\":\"Daedalus Team\"},\"sameAs\":[\"http:\/\/www.daed.com\"],\"url\":\"https:\/\/blog.daed.com\/?author=10\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Why Technical Writing is Essential - daed.com","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/blog.daed.com\/?p=3169","og_locale":"en_US","og_type":"article","og_title":"Why Technical Writing is Essential - daed.com","og_description":"This week, I voted by mail for the first time for the Pennsylvania Primary Election. I\u2019ve always enjoyed voting in person for a variety of reasons, but as a type ...","og_url":"https:\/\/blog.daed.com\/?p=3169","og_site_name":"daed.com","article_published_time":"2020-05-29T19:23:16+00:00","article_modified_time":"2024-07-11T14:59:16+00:00","og_image":[{"width":1000,"height":817,"url":"http:\/\/blog.daed.com\/wp-content\/uploads\/2020\/05\/TorturedPath.png","type":"image\/png"}],"author":"Daedalus Team","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Daedalus Team","Est. reading time":"6 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/blog.daed.com\/?p=3169#article","isPartOf":{"@id":"https:\/\/blog.daed.com\/?p=3169"},"author":{"name":"Daedalus Team","@id":"https:\/\/blog.daed.com\/#\/schema\/person\/f08aac4ae63cbed0fffa61088919d15f"},"headline":"Why Technical Writing is Essential","datePublished":"2020-05-29T19:23:16+00:00","dateModified":"2024-07-11T14:59:16+00:00","mainEntityOfPage":{"@id":"https:\/\/blog.daed.com\/?p=3169"},"wordCount":1159,"publisher":{"@id":"https:\/\/blog.daed.com\/#organization"},"keywords":["Instructions for use","Technical writing"],"articleSection":["design thinking","product development"],"inLanguage":"en-US"},{"@type":"WebPage","@id":"https:\/\/blog.daed.com\/?p=3169","url":"https:\/\/blog.daed.com\/?p=3169","name":"Why Technical Writing is Essential - daed.com","isPartOf":{"@id":"https:\/\/blog.daed.com\/#website"},"datePublished":"2020-05-29T19:23:16+00:00","dateModified":"2024-07-11T14:59:16+00:00","breadcrumb":{"@id":"https:\/\/blog.daed.com\/?p=3169#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/blog.daed.com\/?p=3169"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/blog.daed.com\/?p=3169#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/blog.daed.com\/"},{"@type":"ListItem","position":2,"name":"Why Technical Writing is Essential"}]},{"@type":"WebSite","@id":"https:\/\/blog.daed.com\/#website","url":"https:\/\/blog.daed.com\/","name":"daed.com","description":"research, design, and engineering thinking","publisher":{"@id":"https:\/\/blog.daed.com\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/blog.daed.com\/?s={search_term_string}"},"query-input":"required name=search_term_string"}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/blog.daed.com\/#organization","name":"daed.com","url":"https:\/\/blog.daed.com\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.daed.com\/#\/schema\/logo\/image\/","url":"https:\/\/blog.daed.com\/wp-content\/uploads\/2019\/10\/White_Daedalus.png","contentUrl":"https:\/\/blog.daed.com\/wp-content\/uploads\/2019\/10\/White_Daedalus.png","width":5249,"height":745,"caption":"daed.com"},"image":{"@id":"https:\/\/blog.daed.com\/#\/schema\/logo\/image\/"}},{"@type":"Person","@id":"https:\/\/blog.daed.com\/#\/schema\/person\/f08aac4ae63cbed0fffa61088919d15f","name":"Daedalus Team","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/blog.daed.com\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/524207b1dc467ee81cafe2cc979aa823?s=96&d=mm&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/524207b1dc467ee81cafe2cc979aa823?s=96&d=mm&r=g","caption":"Daedalus Team"},"sameAs":["http:\/\/www.daed.com"],"url":"https:\/\/blog.daed.com\/?author=10"}]}},"_links":{"self":[{"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/posts\/3169"}],"collection":[{"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/users\/10"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.daed.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3169"}],"version-history":[{"count":42,"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/posts\/3169\/revisions"}],"predecessor-version":[{"id":4614,"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/posts\/3169\/revisions\/4614"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.daed.com\/index.php?rest_route=\/wp\/v2\/media\/3529"}],"wp:attachment":[{"href":"https:\/\/blog.daed.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3169"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.daed.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3169"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.daed.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3169"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}