{"id":43652,"date":"2013-02-13T10:38:02","date_gmt":"2013-02-13T11:38:02","guid":{"rendered":"http:\/\/www.corporate-eye.com\/blog\/?p=43652"},"modified":"2021-01-07T18:47:46","modified_gmt":"2021-01-07T17:47:46","slug":"communicating-technical","status":"publish","type":"post","link":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/","title":{"rendered":"Successfully Communicating Your Technical Expertise"},"content":{"rendered":"

I invited Cathy Wellings, an expert in business communication skills, to write another guest post<\/a> for us, this time about communicating technical matters to a non-technical audience. <\/p>\n

Her advice is particularly relevant if you need to communicate a technical subject online, where you cannot assume that your audience will have a technical understanding of your subject.<\/p>\n

Over to you, Cathy…<\/em><\/p>\n

Technical Writing for Non-technical Audiences<\/h2>\n

\"\"<\/span>Technical experts whether in IT, engineering, scientific or other specialist fields are not always well known for the simplicity of their communication. More often than not their spoken presentations or written reports risk baffling their audience or \u2018blinding them with science\u2019. Full of jargon, confusing and\/or irrelevant charts and graphs, and lengthy technical explanations, technical reports in particular, can seem like a labyrinth of unfathomable concepts and assertions to the uninitiated reader.<\/p>\n

It is the responsibility of the writer and not the reader to ensure that the message is understood. And furthermore, technical experts are increasingly required to write to persuade, convince and inform decisions and making the need to create impact even more imperative.<\/p>\n

Below are some simple tips that any good technical writer should have at the forefront of their mind when communicating complex subjects to audiences that potentially have less knowledge than they do.<\/p>\n

    \n
  1. Consider your Audience<\/strong>\n

    For any writing to be effective it needs to have its reader at the centre and this is paramount when it comes to technical writing. What is the point if it doesn\u2019t make sense to the reader? Wherever possible engage with the reader to find out what they require and how much they already know. Why have they requested the document and what will be its end purpose? Speak in language you know they understand and make reference to their context.<\/li>\n

  2. Say What\u2019s Important First<\/strong>\n

    Your audience will not thank you for leaving the best until last. The reality is that many readers will not reach the end of a lengthy technical report and if you want to create real impact it is much more effective to make your most important points first.<\/li>\n

  3. Talk Benefits not Features<\/strong>\n

    Technical experts often have a tendency to spend more time describing the \u2018what\u2019, giving detailed descriptions of the product or process rather than explaining the \u2018why\u2019, focusing on the benefits or added value of what is being described. It is only human to want to know \u2018what\u2019s in this for me?\u2019 or \u2018how will this add value to what I do?\u2019 and so to be an effective technical writer you should focus on providing answers to these questions.<\/li>\n

  4. Avoid Jargon, Acronyms and Technical Language<\/strong>\n

    Make sure your language is user friendly and accessible to your reader. Using jargon and expressions that our audience doesn\u2019t understand risks alienating and confusing them. If you need to use very technical language make sure that you define your terms.\n<\/li>\n

  5. Resist the Temptation to Show off<\/strong>\n

    Writing a successful technical report is not about showing how much you know about the subject but more about how well you convey your message and convince your audience of its value. Again, keeping it simple will be more effective than using overly complicated language and structure. And you certainly don\u2019t want to run the risk of making your reader feel less intelligent.<\/li>\n<\/ol>\n

    So, the message is clear. Keep your audience at the forefront of any technical writing and make sure your document gives them what they really need rather than what you think they need.<\/p>\n

    Thanks Cathy!<\/p>\n

    Cathy Wellings is Head of Communication Skills at Communicaid<\/a> a communications skills consultancy offering business writing courses and other business communication skills training.<\/em><\/p>\n","protected":false},"excerpt":{"rendered":"

    I invited Cathy Wellings, an expert in business communication skills, to write another guest post for us, this time about communicating technical matters to a non-technical audience. Her advice is particularly relevant if you need to communicate a technical subject online, where you cannot assume that your audience will have a technical understanding of your […]<\/p>\n","protected":false},"author":1,"featured_media":43657,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_lmt_disableupdate":"","_lmt_disable":"","_genesis_hide_title":false,"_genesis_hide_breadcrumbs":false,"_genesis_hide_singular_image":false,"_genesis_hide_footer_widgets":false,"_genesis_custom_body_class":"","_genesis_custom_post_class":"","_genesis_layout":"","footnotes":""},"categories":[9,6443],"tags":[],"class_list":{"0":"post-43652","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-best-practices","8":"category-guest","9":"entry"},"yoast_head":"\nSuccessfully Communicating Your Technical Expertise - Corporate Eye<\/title>\n<meta name=\"description\" content=\"Tips for communicating technical matters online\" \/>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Successfully Communicating Your Technical Expertise - Corporate Eye\" \/>\n<meta property=\"og:description\" content=\"Tips for communicating technical matters online\" \/>\n<meta property=\"og:url\" content=\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\" \/>\n<meta property=\"og:site_name\" content=\"Corporate Eye\" \/>\n<meta property=\"article:published_time\" content=\"2013-02-13T11:38:02+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2021-01-07T17:47:46+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"500\" \/>\n\t<meta property=\"og:image:height\" content=\"375\" \/>\n\t<meta property=\"og:image:type\" content=\"image\/jpeg\" \/>\n<meta name=\"author\" content=\"Lucy Nixon\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@lucynixon\" \/>\n<meta name=\"twitter:site\" content=\"@lucynixon\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Lucy Nixon\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"3 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#article\",\"isPartOf\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\"},\"author\":{\"name\":\"Lucy Nixon\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/d273bf7421dc8f5fec96785876b760e2\"},\"headline\":\"Successfully Communicating Your Technical Expertise\",\"datePublished\":\"2013-02-13T11:38:02+00:00\",\"dateModified\":\"2021-01-07T17:47:46+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\"},\"wordCount\":615,\"commentCount\":0,\"publisher\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#organization\"},\"image\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg\",\"articleSection\":[\"Best Practices\",\"Guest\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\",\"url\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\",\"name\":\"Successfully Communicating Your Technical Expertise - Corporate Eye\",\"isPartOf\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#website\"},\"primaryImageOfPage\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage\"},\"image\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage\"},\"thumbnailUrl\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg\",\"datePublished\":\"2013-02-13T11:38:02+00:00\",\"dateModified\":\"2021-01-07T17:47:46+00:00\",\"description\":\"Tips for communicating technical matters online\",\"breadcrumb\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/\"]}]},{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage\",\"url\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg\",\"contentUrl\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg\",\"width\":500,\"height\":375},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/www.corporate-eye.com\/main\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Successfully Communicating Your Technical Expertise\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#website\",\"url\":\"https:\/\/www.corporate-eye.com\/main\/\",\"name\":\"Corporate Eye\",\"description\":\"...compare, compete, excel\",\"publisher\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/www.corporate-eye.com\/main\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#organization\",\"name\":\"Corporate Eye\",\"url\":\"https:\/\/www.corporate-eye.com\/main\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2019\/11\/corporate-eye-logo.png\",\"contentUrl\":\"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2019\/11\/corporate-eye-logo.png\",\"width\":283,\"height\":42,\"caption\":\"Corporate Eye\"},\"image\":{\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#\/schema\/logo\/image\/\"},\"sameAs\":[\"https:\/\/x.com\/lucynixon\"]},{\"@type\":\"Person\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/d273bf7421dc8f5fec96785876b760e2\",\"name\":\"Lucy Nixon\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/image\/\",\"url\":\"https:\/\/secure.gravatar.com\/avatar\/538dc739f95aa5a2fd75d054808b18b2afa37a9282a7a8f87001a77dc128d759?s=96&d=identicon&r=g\",\"contentUrl\":\"https:\/\/secure.gravatar.com\/avatar\/538dc739f95aa5a2fd75d054808b18b2afa37a9282a7a8f87001a77dc128d759?s=96&d=identicon&r=g\",\"caption\":\"Lucy Nixon\"},\"description\":\"Lucy is Editor at Corporate Eye\",\"sameAs\":[\"http:\/\/www.corporate-eye.com\",\"https:\/\/x.com\/lucynixon\"],\"url\":\"https:\/\/www.corporate-eye.com\/main\/author\/lucy\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Successfully Communicating Your Technical Expertise - Corporate Eye","description":"Tips for communicating technical matters online","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:\/\/www.corporate-eye.com\/main\/communicating-technical\/","og_locale":"en_US","og_type":"article","og_title":"Successfully Communicating Your Technical Expertise - Corporate Eye","og_description":"Tips for communicating technical matters online","og_url":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/","og_site_name":"Corporate Eye","article_published_time":"2013-02-13T11:38:02+00:00","article_modified_time":"2021-01-07T17:47:46+00:00","og_image":[{"width":500,"height":375,"url":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg","type":"image\/jpeg"}],"author":"Lucy Nixon","twitter_card":"summary_large_image","twitter_creator":"@lucynixon","twitter_site":"@lucynixon","twitter_misc":{"Written by":"Lucy Nixon","Est. reading time":"3 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#article","isPartOf":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/"},"author":{"name":"Lucy Nixon","@id":"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/d273bf7421dc8f5fec96785876b760e2"},"headline":"Successfully Communicating Your Technical Expertise","datePublished":"2013-02-13T11:38:02+00:00","dateModified":"2021-01-07T17:47:46+00:00","mainEntityOfPage":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/"},"wordCount":615,"commentCount":0,"publisher":{"@id":"https:\/\/www.corporate-eye.com\/main\/#organization"},"image":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage"},"thumbnailUrl":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg","articleSection":["Best Practices","Guest"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/","url":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/","name":"Successfully Communicating Your Technical Expertise - Corporate Eye","isPartOf":{"@id":"https:\/\/www.corporate-eye.com\/main\/#website"},"primaryImageOfPage":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage"},"image":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage"},"thumbnailUrl":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg","datePublished":"2013-02-13T11:38:02+00:00","dateModified":"2021-01-07T17:47:46+00:00","description":"Tips for communicating technical matters online","breadcrumb":{"@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/www.corporate-eye.com\/main\/communicating-technical\/"]}]},{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#primaryimage","url":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg","contentUrl":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2013\/02\/technical.jpg","width":500,"height":375},{"@type":"BreadcrumbList","@id":"https:\/\/www.corporate-eye.com\/main\/communicating-technical\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/www.corporate-eye.com\/main\/"},{"@type":"ListItem","position":2,"name":"Successfully Communicating Your Technical Expertise"}]},{"@type":"WebSite","@id":"https:\/\/www.corporate-eye.com\/main\/#website","url":"https:\/\/www.corporate-eye.com\/main\/","name":"Corporate Eye","description":"...compare, compete, excel","publisher":{"@id":"https:\/\/www.corporate-eye.com\/main\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/www.corporate-eye.com\/main\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/www.corporate-eye.com\/main\/#organization","name":"Corporate Eye","url":"https:\/\/www.corporate-eye.com\/main\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.corporate-eye.com\/main\/#\/schema\/logo\/image\/","url":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2019\/11\/corporate-eye-logo.png","contentUrl":"https:\/\/www.corporate-eye.com\/main\/wp-content\/uploads\/2019\/11\/corporate-eye-logo.png","width":283,"height":42,"caption":"Corporate Eye"},"image":{"@id":"https:\/\/www.corporate-eye.com\/main\/#\/schema\/logo\/image\/"},"sameAs":["https:\/\/x.com\/lucynixon"]},{"@type":"Person","@id":"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/d273bf7421dc8f5fec96785876b760e2","name":"Lucy Nixon","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/www.corporate-eye.com\/main\/#\/schema\/person\/image\/","url":"https:\/\/secure.gravatar.com\/avatar\/538dc739f95aa5a2fd75d054808b18b2afa37a9282a7a8f87001a77dc128d759?s=96&d=identicon&r=g","contentUrl":"https:\/\/secure.gravatar.com\/avatar\/538dc739f95aa5a2fd75d054808b18b2afa37a9282a7a8f87001a77dc128d759?s=96&d=identicon&r=g","caption":"Lucy Nixon"},"description":"Lucy is Editor at Corporate Eye","sameAs":["http:\/\/www.corporate-eye.com","https:\/\/x.com\/lucynixon"],"url":"https:\/\/www.corporate-eye.com\/main\/author\/lucy\/"}]}},"modified_by":"Lucy Nixon","_links":{"self":[{"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/posts\/43652","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/comments?post=43652"}],"version-history":[{"count":6,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/posts\/43652\/revisions"}],"predecessor-version":[{"id":52825,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/posts\/43652\/revisions\/52825"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/media\/43657"}],"wp:attachment":[{"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/media?parent=43652"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/categories?post=43652"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.corporate-eye.com\/main\/wp-json\/wp\/v2\/tags?post=43652"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}