CINXE.COM

Decoding the Role of a Modern Technical Writer - HelpDocs Learn

<!DOCTYPE html><!-- Last Published: Fri Nov 08 2024 10:42:14 GMT+0000 (Coordinated Universal Time) --><html data-wf-domain="www.helpdocs.io" data-wf-page="6567a2e4671dd613ca3766ca" data-wf-site="5d848f0f3ce9fea053031e0b" lang="en" data-wf-collection="6567a2e4671dd613ca376624" data-wf-item-slug="decoding-the-role-of-a-modern-technical-writer"><head><meta charset="utf-8"/><title>Decoding the Role of a Modern Technical Writer - HelpDocs Learn</title><meta content="Technical writing is more than writing manuals and help documentation. But things have changed with new-age teams and AI." name="description"/><meta content="Decoding the Role of a Modern Technical Writer - HelpDocs Learn" property="og:title"/><meta content="Technical writing is more than writing manuals and help documentation. But things have changed with new-age teams and AI." property="og:description"/><meta content="Decoding the Role of a Modern Technical Writer - HelpDocs Learn" property="twitter:title"/><meta content="Technical writing is more than writing manuals and help documentation. But things have changed with new-age teams and AI." property="twitter:description"/><meta property="og:type" content="website"/><meta content="summary_large_image" name="twitter:card"/><meta content="width=device-width, initial-scale=1" name="viewport"/><link href="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/css/helpdocs-marketing-site.webflow.cce9ef748.min.css" rel="stylesheet" type="text/css"/><link href="https://fonts.googleapis.com" rel="preconnect"/><link href="https://fonts.gstatic.com" rel="preconnect" crossorigin="anonymous"/><script src="https://ajax.googleapis.com/ajax/libs/webfont/1.6.26/webfont.js" type="text/javascript"></script><script type="text/javascript">WebFont.load({ google: { families: ["Exo:100,100italic,200,200italic,300,300italic,400,400italic,500,500italic,600,600italic,700,700italic,800,800italic,900,900italic","Inter:regular,500,600","Rubik:regular,500,700","Playfair Display:regular,600,800,italic","IBM Plex Sans:300,regular,500,600"] }});</script><script type="text/javascript">!function(o,c){var n=c.documentElement,t=" w-mod-";n.className+=t+"js",("ontouchstart"in o||o.DocumentTouch&&c instanceof DocumentTouch)&&(n.className+=t+"touch")}(window,document);</script><link href="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5d9489094cde5d6a4c5fc33a_favicon-32x32.png" rel="shortcut icon" type="image/x-icon"/><link href="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5da2d005848a16d320d87e0f_pink%20background%20symbol.png" rel="apple-touch-icon"/><script async="" src="https://www.googletagmanager.com/gtag/js?id=G-K46CXZ7B0Z"></script><script type="text/javascript">window.dataLayer = window.dataLayer || [];function gtag(){dataLayer.push(arguments);}gtag('js', new Date());gtag('set', 'developer_id.dZGVlNj', true);gtag('config', 'G-K46CXZ7B0Z');</script><style> body{ -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; } </style> <link rel="stylesheet" type="text/css" href="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.0.3/cookieconsent.min.css"/> <script src="//cdnjs.cloudflare.com/ajax/libs/cookieconsent2/3.0.3/cookieconsent.min.js"></script> <!-- Global site tag (gtag.js) - Google Analytics --> <!-- Google tag (gtag.js) --> <script async src="https://www.googletagmanager.com/gtag/js?id=G-K46CXZ7B0Z"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-K46CXZ7B0Z'); </script> <script defer data-domain="helpdocs.io" event-domain="Marketing Site" src="https://plausible.io/js/script.pageview-props.tagged-events.js"></script> <script> window.addEventListener("load", function(){ window.cookieconsent.initialise({ "palette": { "popup": { "background": "#ffffff", "text": "#f54599" }, "button": { "background": "#ffdcea", "text": "#f71272" } }, "theme": "edgeless", "position": "bottom", "static": false, "content": { "message": "馃崻 We use cookies to make your experience awesome on our website.", "href": "https://www.helpdocs.io/privacy/" } })}); </script> <script type="application/ld+json"> { "@context": "https://schema.org", "@type": "Organization", "name": "HelpDocs", "legalName" : "HelpDocs", "url": "https://helpdocs.io", "logo": "https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5d849aa33ce9fe26db039c15_color_wordmark.svg", "foundingDate": "2016", "founders": [ { "@type": "Person", "name": "Jake Peters" }, { "@type": "Person", "name": "Jarratt Isted" } ], "contactPoint": { "@type": "ContactPoint", "contactType": "customer support", "email": "hi@helpdocs.io" }, "sameAs": [ "http://www.facebook.com/helpdocs", "http://www.twitter.com/helpdocs", "https://www.instagram.com/helpdocsio" ] }, </script> <script> !function(g,s,q,r,d){r=g[r]=g[r]||function(){(r.q=r.q||[]).push( arguments)};d=s.createElement(q);q=s.getElementsByTagName(q)[0]; d.src='//d1l6p2sc9645hc.cloudfront.net/tracker.js';q.parentNode. insertBefore(d,q)}(window,document,'script','_gs'); _gs('set', 'cookieDomain', '.helpdocs.io'); _gs('set', 'anonymizeIP', true); _gs('GSN-921790-D'); _gs('set', 'chat', { button: false }); </script> <script> (function() { var ref = document.referrer; if (!ref) return; var banRefs = [ 'flexjobs.com', 'themighty.com' ]; banRefs.forEach(function(r) { if (r.indexOf(ref) > -1) { window.location.href = 'https://www.' + r; } }) })(); </script> <!-- Hotjar Tracking Code for www.helpdocs.io --> <script> (function(h,o,t,j,a,r){ h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)}; h._hjSettings={hjid:335905,hjsv:6}; a=o.getElementsByTagName('head')[0]; r=o.createElement('script');r.async=1; r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv; a.appendChild(r); })(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv='); </script> <!-- Slack app suggestions--> <meta name="slack-app-id" content="A3Y1X4NG5"/> <!-- Open graph --> <meta property="og:title" content="Knowledge Base Software - HelpDocs"/> <meta property="og:type" content="website"/> <meta property="og:url" content="https://www.helpdocs.io"/> <meta property="og:image" content="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5db11c3d71caa28009caea80_Screenshot%202019-10-24%2010.35.09.png"/> <!-- [Attributes by Finsweet] CMS Nest --> <script async src="https://cdn.jsdelivr.net/npm/@finsweet/attributes-cmsnest@1/cmsnest.js"></script></head><body><header id="nav" class="sticky-nav event_nav"><a href="/learn" class="link-block-9 w-inline-block"><ul role="list" class="list guides"><li class="icon-list-item icon-list-horizontal-item"><img src="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5d848f103ce9fe1617031e51_icon-arrow-left.svg" height="25" alt="" class="icon-list-image heart"/><h6 class="text-small-caps learn-event">Go back to Learn</h6></li></ul></a></header><div class="section-19 learns"><div class="w-container"><div class="w-row"><div class="column-14 w-col w-col-6"><div class="div-block-31"><p class="paragraph-18">Resource</p><div class="pill pill-notice bg-primary-2 exclusive-pill w-condition-invisible"><div class="text-block-13">馃専Exclusive for Customers</div></div><h1 class="heading-41 event_title">Decoding the Role of a Modern Technical Writer</h1><p class="paragraph-20 event_desc">Technical writing is more than writing manuals and help documentation. But things have changed with new-age teams and AI.</p><a href="https://blog.helpdocs.io/decoding-the-role-of-a-modern-technical-writer/" class="button button-large event_button w-button">Check it out</a></div></div><div class="column-13 w-col w-col-6"><div class="host-block w-condition-invisible"><div class="div-block-27"><div class="text-block-34">Hosted by</div></div><div class="div-block-28 w-clearfix"><div class="html-embed-8 w-embed"><img src="" alt="" height="40" width="40" style="border-radius: 50%" /></div><div class="text-block-35 w-dyn-bind-empty"></div></div></div><div class="guest-block w-condition-invisible"><div class="div-block-27"><div class="text-block-34">With guest</div></div><div class="div-block-28"><img alt="" src="" class="image-34 w-condition-invisible w-dyn-bind-empty"/><div class="text-block-35 w-condition-invisible w-dyn-bind-empty"></div></div></div><img src="https://cdn.prod.website-files.com/5d848f103ce9fe05b9031e19/6605608127c5aa64c5404b77_role-of-technical-writer.png" loading="lazy" alt="" class="learn-event-image"/></div></div></div><div class="container-8 w-condition-invisible w-container"><div><div class="html-embed-12 w-condition-invisible w-embed w-script"><div id="embeddable-replace"></div> <script> (function() { var html = ""; html = html .replace(/&gt;/g, ">") .replace(/&lt;/g, "<") .replace(/&amp;/g, "&") .replace(/&quot;/g, "\""); var el = document.getElementById('embeddable-replace'); if (el) el.outerHTML = html; })(); </script> <script type="text/javascript" src="https://assets.calendly.com/assets/external/widget.js"></script> <script>(function() { var qs,js,q,s,d=document, gi=d.getElementById, ce=d.createElement, gt=d.getElementsByTagName, id="typef_orm", b="https://embed.typeform.com/"; if(!gi.call(d,id)) { js=ce.call(d,"script"); js.id=id; js.src=b+"embed.js"; q=gt.call(d,"script")[0]; q.parentNode.insertBefore(js,q) } })()</script></div></div></div></div><div class="site-footer"><div class="container-12 w-container"><div class="w-layout-grid grid-45"><img src="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/5daad5be51ef3a03927efc78_color%20symbol.png" loading="lazy" width="50" id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660268-2e660265" alt="HelpDocs logo"/><div id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660269-2e660265" class="footer-top-link"><a href="/pricing" class="footer-top-link-inner">Pricing</a></div><div id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e66026c-2e660265" class="footer-top-link"><a href="/showcase" class="footer-top-link-inner">Showcase</a></div><div id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e66026f-2e660265" class="footer-top-link"><a href="/learn" class="footer-top-link-inner">Learn</a></div><div id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660272-2e660265" class="footer-top-link"><a href="https://blog.helpdocs.io" target="_blank" class="footer-top-link-inner">Blog</a></div><div id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660275-2e660265" class="footer-top-link"><a href="https://status.helpdocs.io" class="utlink w-inline-block"><div class="uptime up"><span class="desc">All Systems Operational</span> </div></a></div></div><div class="div-block-51"></div><div class="w-layout-grid grid-99"><h6 id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660279-2e660265" class="heading-75">Product</h6><h6 id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e66027b-2e660265" class="heading-75">Company</h6><h6 id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e66027d-2e660265" class="heading-75">Account</h6><ul id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e66027f-2e660265" role="list" class="link-menu w-list-unstyled"><li class="link-menu-item"><a href="/pricing" class="footer-link">Pricing</a></li><li class="link-menu-item"><a href="/grow" class="footer-link">Grow Plan</a></li><li class="link-menu-item"><a href="/showcase" target="_blank" class="footer-link">Showcase</a></li><li class="link-menu-item"><a href="https://support.helpdocs.io/" target="_blank" class="footer-link">Support</a></li><li class="link-menu-item"><a href="/integrations" class="footer-link">Integrations</a></li><li class="link-menu-item"><a href="/lighthouse" class="footer-link">Lighthouse</a></li><li class="link-menu-item"><a href="https://chrome.google.com/webstore/detail/helpdocs-knowledge-base-s/lpaajdabalfldklgecgploegecelijji" target="_blank" class="footer-link">Chrome Extension</a></li></ul><ul id="w-node-_9e3dd0c9-e91c-5695-395e-c7392e660295-2e660265" role="list" class="link-menu w-list-unstyled"><li class="link-menu-item"><a href="/about" class="footer-link">About</a></li><li class="link-menu-item"><a href="https://blog.helpdocs.io/" target="_blank" class="footer-link">Blog</a></li><li class="link-menu-item"><a href="https://blog.helpdocs.io/tag/customer-stories/" target="_blank" class="footer-link">Customer Stories</a></li><li class="link-menu-item"><a href="/jobs" class="footer-link">Jobs</a></li><li class="link-menu-item"><a href="https://courses.helpdocs.io/?ref=footer" target="_blank" class="footer-link">Courses</a></li><li class="link-menu-item"><a href="/guides" class="footer-link">Guides</a></li><li class="link-menu-item"><a href="/learn" class="footer-link">Learn</a></li></ul><ul role="list" class="link-menu w-list-unstyled"><li class="link-menu-item"><a href="/signup" class="footer-link">Sign up</a></li><li class="link-menu-item"><a href="https://my.helpdocs.io/login" target="_blank" class="footer-link">Log in</a></li><li class="link-menu-item"><a href="/terms" class="footer-link">Terms</a></li><li class="link-menu-item"><a href="/privacy" target="_blank" class="footer-link">Privacy</a></li><li class="link-menu-item"><a href="https://www.helpdocs.io/search" class="footer-link">Search</a></li></ul></div></div></div><script src="https://d3e54v103j8qbb.cloudfront.net/js/jquery-3.5.1.min.dc5e7f18c8.js?site=5d848f0f3ce9fea053031e0b" type="text/javascript" integrity="sha256-9/aliU8dGd2tb6OSsuzixeV4y/faTqgFtohetphbbj0=" crossorigin="anonymous"></script><script src="https://cdn.prod.website-files.com/5d848f0f3ce9fea053031e0b/js/webflow.2e327327c.js" type="text/javascript"></script><script type="text/javascript"> window.hdlh = { widget_key: "P3vByySEuDjngJps66xv", color_mode: "light", ignore_contact_widgets: true, onNavigate: function(data) { if (data.page !== 'contact') return; setTimeout(function() { try { var contact = document.querySelector('#lighthouse #MainFrame').contentDocument.querySelector('.Contact'); var disclaimer = document.createElement('p'); disclaimer.style.userSelect = 'none'; disclaimer.style.color = '#aaa'; disclaimer.style.fontSize = '0.8em'; disclaimer.style.textAlign = 'center'; disclaimer.innerHTML = "You're contacting <a href='https://www.helpdocs.io' target='_blank' style='color:#f45599;font-weight:bold;'>HelpDocs</a> support. If you're looking for a different company you'll need to reach out to them directly."; contact.insertBefore(disclaimer, contact.firstChild); } catch(e) { console.log(e); } }, 1); } }; (function(h,d){var s=d.createElement("script");s.type='text/javascript';s.async=true;s.src=h+"?t="+new Date().getTime();d.head.appendChild(s);})("https://lighthouse.helpdocs.io/load",document); </script> <script> (function() { function ready(fn) { if (document.readyState != 'loading'){ fn(); } else if (document.addEventListener) { document.addEventListener('DOMContentLoaded', fn); } else { document.attachEvent('onreadystatechange', function() { if (document.readyState != 'loading') fn(); }); } } ready(function() { var qs = (function(a) { if (a == "") return {}; var b = {}; for (var i = 0; i < a.length; ++i) { var p=a[i].split('=', 2); if (p.length == 1) b[p[0]] = ""; else b[p[0]] = decodeURIComponent(p[1].replace(/\+/g, " ")); } return b; })(window.location.search.substr(1).split('&')); // Return if there's no error if (!(qs.error || qs.reason)) return; // Get the message from the query string, then create a string of HTML to // insert into the DOM var message = qs.reason || qs.error; if (message.indexOf('Whoah') === 0) { message = "You've tried to access an account/page that does not exist" } else { console.log("unknown error provided in query string", message) message = "Something went wrong" } var errNode = document.createElement('div'); errNode.innerHTML = '<div class="alert alert-danger text-xs-center" role="alert" style="border-radius: 0; width:100%; text-align:center; padding: 0.5em; background-color: red; color: white;"><strong style="color: white;">Error</strong><span style="margin-left: 0.25em;">' + message + '</span></div>'; // Store #err div as an object for later var errDiv = document.createElement('div'); errDiv.id = 'err'; errDiv.appendChild(errNode); document.body.insertBefore(errDiv, document.body.firstChild); return; }) })(); </script> <script type="text/javascript"> (function(i,s,o,g,r,a,m){i['ProfitWellObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m); })(window,document,'script','https://dna8twue3dlxq.cloudfront.net/js/profitwell.js','profitwell'); profitwell('auth_token', 'a512f9a49ff8d53a5cd48c24982f6cb2'); </script> <script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/js-cookie/2.1.4/js.cookie.min.js"></script> <script type="text/javascript"> (function() { var qs = (function(a) { if (a == "") return {}; var b = {}; for (var i = 0; i < a.length; ++i) { var p = a[i].split('=', 2); if (p.length == 1) { b[p[0]] = ""; } else { b[p[0]] = decodeURIComponent(p[1].replace(/\+/g, " ")); } } return b; })(window.location.search.substr(1).split('&')); if (qs.ref && !Cookies.get('_hdref')) Cookies.set('_hdref', qs.ref, { expires: 30 }); if (qs.aff) Cookies.set('_hdaff', qs.aff, { expires: 30 }); })(); </script> <script> var dataAttribute = 'data-lighthouse'; // Get all elements on the page with the data attribute var dataEls = document.querySelectorAll(`[${dataAttribute}]`); try { if (!dataEls) throw 'No data-lighthouse found on this page'; Array.prototype.forEach.call(dataEls, dEl => { var data = dEl.getAttribute(dataAttribute); if (!data) throw 'Could\'nt find data attribute'; data = data.split('-'); if (data.length !== 2) throw 'You need to include a method and content ID'; dEl.setAttribute('onclick', `Lighthouse.navigate('${data[0]}','${data[1]}')`); }); } catch (e) { console.log(e); } </script> <script> /* Hyperping Status code for footer */ var statusReq = new Request('https://app.hyperping.io/api/v1/status.helpdocs.io/status.json'); fetch(statusReq) .then(response => response.json()) .then(data => { console.log(data) if (Object.keys(data).length < 1) return; var uptime = document.querySelector('.status .uptime'); var utDesc = document.querySelector('.status .uptime span.desc'); var utLink = document.querySelector('a.utlink.w-inline-block'); if (!utDesc || !utLink) return; if (uptime) { uptime.classList.add(data.indicator); } else { uptime.className += ' ' + data.indicator; } if (utDesc) { var description; switch(data.indicator) { case 'down': description = '馃寶 ' + data.status break; case 'maintenance': description = '馃洜 ' + data.status case 'partialoutage': description = '鈿狅笍 ' + data.status break; default: description = '馃晩' + data.status; } utDesc.innerHTML = description; } else { utDesc.innerHTML = 'Status'; } if (utLink) { utLink.href = data.url; utLink.setAttribute('target', '_blank'); } }); </script></body></html>

Pages: 1 2 3 4 5 6 7 8 9 10