{"id":3226,"date":"2020-06-04T04:10:55","date_gmt":"2020-06-04T04:10:55","guid":{"rendered":"https:\/\/blog.hassler.ec\/wp\/?p=3226"},"modified":"2020-05-16T01:14:02","modified_gmt":"2020-05-16T01:14:02","slug":"tone-of-voice-strategy-in-technical-documentation","status":"publish","type":"post","link":"https:\/\/blog.hassler.ec\/wp\/2020\/06\/04\/tone-of-voice-strategy-in-technical-documentation\/","title":{"rendered":"Tone of Voice Strategy in Technical Documentation"},"content":{"rendered":"<div class=\"n p\">\n<div class=\"z ab ac ae af fb ah ai\">\n<div>\n<div id=\"4f9f\" class=\"fc fd da bq fe b ff fg fh fi fj fk fl fm fn fo fp\"><\/div>\n<\/div>\n<\/div>\n<\/div>\n<div class=\"ii ai\">\n<figure class=\"ij ik il im in ii ai paragraph-image\">\n<div class=\"is r ck it\">\n<div class=\"iu iv r\">\n<div class=\"cj io s t u ip ai cc iq ir\"><img loading=\"lazy\" decoding=\"async\" class=\"pb rb s t u ip ai iz\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/1880\/1*1m6jJR9DKtt4S5930il7Aw.jpeg\" sizes=\"auto, 1880px\" srcset=\"https:\/\/miro.medium.com\/max\/552\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 276w, https:\/\/miro.medium.com\/max\/1104\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 552w, https:\/\/miro.medium.com\/max\/1280\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 640w, https:\/\/miro.medium.com\/max\/1456\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 728w, https:\/\/miro.medium.com\/max\/1632\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 816w, https:\/\/miro.medium.com\/max\/1808\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 904w, https:\/\/miro.medium.com\/max\/1984\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 992w, https:\/\/miro.medium.com\/max\/2160\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 1080w, https:\/\/miro.medium.com\/max\/2700\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 1350w, https:\/\/miro.medium.com\/max\/3240\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 1620w, https:\/\/miro.medium.com\/max\/3760\/1*1m6jJR9DKtt4S5930il7Aw.jpeg 1880w\" width=\"1880\" height=\"1254\" \/><\/div>\n<\/div>\n<\/div>\n<\/figure>\n<\/div>\n<div class=\"n p\">\n<div class=\"z ab ac ae af fb ah ai\">\n<p id=\"34ad\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">The tone of voice is quite a popular idea, especially for big companies. It provides the means to improve communication and connect with clients on a more personal level. Is there a place for the tone of voice in help authoring? We think there is. It is called\u00a0<a class=\"cn dq ie if ig ih\" href=\"https:\/\/clickhelp.com\/software-documentation-glossary\/technical-communication\" target=\"_blank\" rel=\"noopener nofollow noreferrer\">technical\u00a0<strong class=\"hm ja\">communication<\/strong><\/a>\u00a0after all.<\/p>\n<p id=\"0c6d\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">Let\u2019s try to understand what the tone of voice is and find the best ways to apply it to help writing.<\/p>\n<figure class=\"ij ik il im in ii ep eq paragraph-image\">\n<div class=\"ep eq jb\">\n<div class=\"is r ck it\">\n<div class=\"jc iv r\">\n<div class=\"cj io s t u ip ai cc iq ir\"><img loading=\"lazy\" decoding=\"async\" class=\"pb rb s t u ip ai iz\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/714\/0*6jZlTsAc4ilt_aNM.png\" sizes=\"auto, 700px\" srcset=\"https:\/\/miro.medium.com\/max\/552\/0*6jZlTsAc4ilt_aNM.png 276w, https:\/\/miro.medium.com\/max\/1104\/0*6jZlTsAc4ilt_aNM.png 552w, https:\/\/miro.medium.com\/max\/1280\/0*6jZlTsAc4ilt_aNM.png 640w, https:\/\/miro.medium.com\/max\/1400\/0*6jZlTsAc4ilt_aNM.png 700w\" width=\"714\" height=\"168\" \/><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n<h1 id=\"8d00\" class=\"jd je da bq bp jf ff jg fh jh ji jj jk jl jm jn jo\" data-selectable-paragraph=\"\">The Voice of Your Company<\/h1>\n<figure class=\"ij ik il im in ii ep eq paragraph-image\">\n<div class=\"ep eq jp\">\n<div class=\"is r ck it\">\n<div class=\"jq iv r\">\n<div class=\"cj io s t u ip ai cc iq ir\"><\/div>\n<p><img loading=\"lazy\" decoding=\"async\" class=\"pb rb s t u ip ai iz\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/700\/0*_EYPx6THknew1DZX.jpg\" sizes=\"auto, 700px\" srcset=\"https:\/\/miro.medium.com\/max\/552\/0*_EYPx6THknew1DZX.jpg 276w, https:\/\/miro.medium.com\/max\/1104\/0*_EYPx6THknew1DZX.jpg 552w, https:\/\/miro.medium.com\/max\/1280\/0*_EYPx6THknew1DZX.jpg 640w, https:\/\/miro.medium.com\/max\/1400\/0*_EYPx6THknew1DZX.jpg 700w\" width=\"700\" height=\"467\" \/><\/div>\n<\/div>\n<\/div>\n<\/figure>\n<p id=\"e594\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">The tone of voice is how you choose to speak to clients through all communication channels. This includes everything starting from the actual voice tones of your phone support, sales reps and ending with images on your website and the lexical units your company chooses in its texts. It\u2019s like your whole company is a human being that has a character which is reflected in everything it does. The tone of voice is how you would like to be seen, or\u2026heard.<\/p>\n<p id=\"254a\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">Ideally, every person in your company is trying to be nice and helpful to customers, but everyone has a different idea of what this means. When a company has a tone of voice strategy mapped out, all employees understand how exactly they should communicate with clients. This is a conscious choice to move from random acts of niceness to a major goal-driven strategy.<\/p>\n<p id=\"d01a\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">This is when it brings maximum results. If that\u2019s the case for you, the documentation team will be able to use the corporate guidelines and follow them.<\/p>\n<h1 id=\"05fc\" class=\"jd je da bq bp jf ff jg fh jh ji jj jk jl jm jn jo\" data-selectable-paragraph=\"\">The Voice of Your Documentation<\/h1>\n<p id=\"908f\" class=\"hk hy da bq hm b hn jr hz hp js ia hr jt ib ht ju ic hv jv id hx ew\" data-selectable-paragraph=\"\">Sometimes, the documentation team has to come up with a voice of tone strategy on its own when all that is available to them is a vague idea of what the overall tone of voice for the company is. This is especially true for technical writing agencies \u2014 they have to create\u00a0<a class=\"cn dq ie if ig ih\" href=\"https:\/\/clickhelp.com\/software-documentation-glossary\/user-manual\" target=\"_blank\" rel=\"noopener nofollow noreferrer\">user manuals<\/a>\u00a0for many companies and sometimes the tone of voice is simply not part of the conversation. Often, companies still view technical documentation as something that is not supposed to be influenced by the tone of voice strategy, unlike marketing\/customer success. However, we advise that you go through this anyway \u2014 it works perfectly as a side question for better understanding how to treat the target audience right.<\/p>\n<h1 id=\"6439\" class=\"jd je da bq bp jf ff jg fh jh ji jj jk jl jm jn jo\" data-selectable-paragraph=\"\">Voice of Tone Advice for Tech Writers<\/h1>\n<figure class=\"ij ik il im in ii ep eq paragraph-image\">\n<div class=\"ep eq jp\">\n<div class=\"is r ck it\">\n<div class=\"jq iv r\">\n<div class=\"cj io s t u ip ai cc iq ir\"><img loading=\"lazy\" decoding=\"async\" class=\"pb rb s t u ip ai iz\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/700\/0*yRCx9ld7zlKUmKjZ.jpg\" sizes=\"auto, 700px\" srcset=\"https:\/\/miro.medium.com\/max\/552\/0*yRCx9ld7zlKUmKjZ.jpg 276w, https:\/\/miro.medium.com\/max\/1104\/0*yRCx9ld7zlKUmKjZ.jpg 552w, https:\/\/miro.medium.com\/max\/1280\/0*yRCx9ld7zlKUmKjZ.jpg 640w, https:\/\/miro.medium.com\/max\/1400\/0*yRCx9ld7zlKUmKjZ.jpg 700w\" width=\"700\" height=\"467\" \/><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n<p id=\"ed6f\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">When you write documentation, every word choice matters. We have some tips for you how to make the right one:<\/p>\n<ul class=\"\">\n<li id=\"234d\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx jw jx jy\" data-selectable-paragraph=\"\">Speak the language of your audience. Make this a statement in the strategy. To make this happen, pay attention to what clients are saying, how they talk to each other on the forums, conferences.<\/li>\n<li id=\"85bf\" class=\"hk hy da bq hm b hn jz hz hp ka ia hr kb ib ht kc ic hv kd id hx jw jx jy\" data-selectable-paragraph=\"\">Would you prefer to sound like a guru and teach readers or does your company prefer a peer-to-peer approach? This alters the results of help authoring greatly, so you should carefully consider the overall impression your texts should have.<\/li>\n<li id=\"6300\" class=\"hk hy da bq hm b hn jz hz hp ka ia hr kb ib ht kc ic hv kd id hx jw jx jy\" data-selectable-paragraph=\"\">Depending on how you would like to be viewed by readers, choose the appropriate style of speech. For example, when it is more on the peer-to-peer side, some companies even add jokes to docs. Too bold a move? Well, this is not the only way to make this happen. Using less official tone and simpler lexical units, encouraging readers to participate in discussions in the comment section, making documentation more inviting by using friendlier titles of reference links (\u2018Check out our documentation\u2019 instead of more official \u2018Refer to documentation here\u2019) this all constitutes a certain tone of voice.<\/li>\n<li id=\"a9bd\" class=\"hk hy da bq hm b hn jz hz hp ka ia hr kb ib ht kc ic hv kd id hx jw jx jy\" data-selectable-paragraph=\"\">What\u2019s the key to success in any enterprise? Consistency! When you figured out your tone of voice, go through with it. Don\u2019t make your brand look like a lagging android that is meant to be friendly and reliable and all of a sudden \u2018surprises\u2019 clients with a cold shoulder, like a piece of text that is strikingly different stylistically and emotionally from the rest of communication.<\/li>\n<\/ul>\n<h1 id=\"8bc1\" class=\"jd je da bq bp jf ff jg fh jh ji jj jk jl jm jn jo\" data-selectable-paragraph=\"\">Conclusion<\/h1>\n<p id=\"acb8\" class=\"hk hy da bq hm b hn jr hz hp js ia hr jt ib ht ju ic hv jv id hx ew\" data-selectable-paragraph=\"\">When you generate a tone of voice strategy for the technical docs you are creating, the best place to keep it is the documentation plan. Let your team access and revisit the strategy in a convenient manner. Read more on documentation plans in this\u00a0<a class=\"cn dq ie if ig ih\" href=\"https:\/\/clickhelp.com\/clickhelp-technical-writing-blog\/how-to-write-a-technical-documentation-plan\/\" target=\"_blank\" rel=\"noopener nofollow noreferrer\">article<\/a>.<\/p>\n<p id=\"c204\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">No use case is the same, of course. Find your own voice and see whether what you are doing at the moment fully supports it.<\/p>\n<p id=\"37fe\" class=\"hk hy da bq hm b hn ho hz hp hq ia hr hs ib ht hu ic hv hw id hx ew\" data-selectable-paragraph=\"\">Good luck with your technical writing!<br \/>\n<a class=\"cn dq ie if ig ih\" href=\"https:\/\/www.facebook.com\/ClickHelp.TechWriting\/\" target=\"_blank\" rel=\"noopener nofollow noreferrer\">ClickHelp Team<\/a><br \/>\nAuthor, host and deliver documentation across platforms and devices<\/p>\n<figure class=\"ij ik il im in ii ep eq paragraph-image\">\n<div class=\"ep eq ke\">\n<div class=\"is r ck it\">\n<div class=\"kf iv r\">\n<div class=\"cj io s t u ip ai cc iq ir\"><img loading=\"lazy\" decoding=\"async\" class=\"pb rb s t u ip ai iz\" role=\"presentation\" src=\"https:\/\/miro.medium.com\/max\/1000\/0*sHST5ttSPilcpK7n.png\" sizes=\"auto, 700px\" srcset=\"https:\/\/miro.medium.com\/max\/552\/0*sHST5ttSPilcpK7n.png 276w, https:\/\/miro.medium.com\/max\/1104\/0*sHST5ttSPilcpK7n.png 552w, https:\/\/miro.medium.com\/max\/1280\/0*sHST5ttSPilcpK7n.png 640w, https:\/\/miro.medium.com\/max\/1400\/0*sHST5ttSPilcpK7n.png 700w\" width=\"1000\" height=\"450\" \/><\/div>\n<\/div>\n<\/div>\n<\/div>\n<\/figure>\n<\/div>\n<\/div>\n<div><\/div>\n<div><\/div>\n<div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div>\n<p data-selectable-paragraph=\"\">\n<p data-selectable-paragraph=\"\"><strong>Source: <a href=\"https:\/\/medium.com\/level-up-web\/tone-of-voice-strategy-in-technical-documentation-9f46d8575be9\">https:\/\/medium.com\/level-up-web\/tone-of-voice-strategy-in-technical-documentation-9f46d8575be9 <\/a><\/strong><\/p>\n<p data-selectable-paragraph=\"\">\n<p data-selectable-paragraph=\"\"><strong>Written by<\/strong><\/p>\n<div class=\"l gj gt gu\"><a href=\"https:\/\/medium.com\/@clickhelp?source=follow_footer--------------------------follow_footer-\" rel=\"noopener\"><img loading=\"lazy\" decoding=\"async\" class=\"l dn gv gw alignleft\" src=\"https:\/\/miro.medium.com\/fit\/c\/80\/80\/1*7dOn0eBnW1yYWSZfVynWgQ.png\" alt=\"ClickHelp\" width=\"80\" height=\"80\" \/><\/a><a class=\"bz ca cb cc cd ce cf cg ch ci cj ck cl cm cn co\" href=\"https:\/\/medium.com\/@clickhelp?source=follow_footer--------------------------follow_footer-\" rel=\"noopener\">ClickHelp<\/a><\/div>\n<div class=\"gx hl l gy az\">\n<div class=\"hm l\">\n<h4 class=\"bb et hn ho bg\">ClickHelp &#8211; Professional Online Technical Writing Tool. Check it out: <a href=\"https:\/\/clickhelp.com\/online-documentation-tool\/\">https:\/\/clickhelp.com\/online-documentation-tool\/<\/a><\/h4>\n<\/div>\n<\/div>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<\/div>\n<p>&nbsp;<\/p>\n<p>&nbsp;<\/p>\n<\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n<div><\/div>\n","protected":false},"excerpt":{"rendered":"<p>The tone of voice is quite a popular idea, especially for big companies. It provides the means to improve communication [&hellip;]<\/p>\n","protected":false},"author":2,"featured_media":3228,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"site-sidebar-layout":"default","site-content-layout":"","ast-site-content-layout":"default","site-content-style":"default","site-sidebar-style":"default","ast-global-header-display":"","ast-banner-title-visibility":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","astra-migrate-meta-layouts":"default","ast-page-background-enabled":"default","ast-page-background-meta":{"desktop":{"background-color":"var(--ast-global-color-4)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"ast-content-background-meta":{"desktop":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"tablet":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""},"mobile":{"background-color":"var(--ast-global-color-5)","background-image":"","background-repeat":"repeat","background-position":"center center","background-size":"auto","background-attachment":"scroll","background-type":"","background-media":"","overlay-type":"","overlay-color":"","overlay-opacity":"","overlay-gradient":""}},"footnotes":""},"categories":[12,128,47,21,40],"tags":[161],"class_list":["post-3226","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-bloghassler-ec","category-clickhelp","category-medium","category-productividad","category-technical-writer","tag-click-help"],"_links":{"self":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/3226","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/comments?post=3226"}],"version-history":[{"count":1,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/3226\/revisions"}],"predecessor-version":[{"id":3229,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/posts\/3226\/revisions\/3229"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/media\/3228"}],"wp:attachment":[{"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/media?parent=3226"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/categories?post=3226"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.hassler.ec\/wp\/wp-json\/wp\/v2\/tags?post=3226"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}