{"id":407,"date":"2018-03-28T09:17:46","date_gmt":"2018-03-28T13:17:46","guid":{"rendered":"https:\/\/lios.dev.creationsunivers.net\/what-should-you-look-for-in-a-technical-writer\/"},"modified":"2018-03-28T09:17:46","modified_gmt":"2018-03-28T13:17:46","slug":"what-should-you-look-for-in-a-technical-writer","status":"publish","type":"post","link":"https:\/\/lios.dev.creationsunivers.net\/en\/what-should-you-look-for-in-a-technical-writer\/","title":{"rendered":"What Should You Look for in a Technical Writer?"},"content":{"rendered":"

So, you\u2019re ready? You\u2019ve taken a hard look and admitted that your technical documentation could be, well, better? It now seems obvious that asking your tech people to write user guides really is a bad use of their skills? You\u2019ve made a decision: You\u2019re going to hire a professional to produce technical documentation worthy of your products and branding! After all, technical documentation is part of the customer experience. Here are the five things you should look for in a technical writer.
\n\"\"<\/p>\n

1. Digging up and analyzing information<\/h4>\n

\"\"Maybe you thought writing well should be a technical writer\u2019s top skill? It is<\/em> important (we\u2019ll come back to this!) but, before even writing a single line, a technical writer has to have done a key part: gathering and understanding the information to be communicated.<\/p>\n

Everybody knows: To explain things well, you have to understand them first. And for that, you need to find a writer who is a good listener and a quick study (who\u2019s got time to repeat the same information over and over? Probably not you!).<\/p>\n

Of course, finding someone who is familiar with your products and technology would be awesome. But just as good a choice is a smart writer who isn\u2019t afraid of the content and knows what questions to ask when!<\/p>\n

2. Writing and communication skills<\/h4>\n

\"\"Ah, here we go! Like we said above, a good technical writer has to be a good writer. No exceptions. But what does that mean exactly? It means that above and beyond writing grammatically correct and typo-free sentences, a technical writer has to be able to produce clear content in plain language that\u2019s well-structured, easy to understand and reader oriented.<\/p>\n

Actually, a good technical writer doesn\u2019t even need words to communicate. He or she knows when using figures, charts, tables, illustrations and screenshots is the best way to get information across. As Tom Johnson<\/a> says, this is important because \u201cany time you can show an idea graphically, you score a hundred points with the reader.\u201d<\/p>\n

Finally, and probably most importantly, technical writers have to be able to see things from the readers\u2019 point of view. Skilled technical writers step into the readers\u2019 shoes to decide what information they\u2019ll need and how to present it.<\/p>\n

3. Mastering the tools<\/h4>\n

\"\"Surely you don\u2019t think your technical writer works with pencil and paper, now do you? Actually, you shouldn\u2019t even settle for a writer who uses just word processing. Today, technical writing involves way more than drafting documents! Your writer must master tools for communicating, creating and managing content, as well as those for project management and the most commonly used image-creation software. They should master tools you don\u2019t even use in your office. After all, a good technical writer is also there to advise you about which tools will help you produce and manage your documentation more efficiently.<\/p>\n

4. Making the most of internal expertise<\/h4>\n

\"\"A good technical writer has to be independent, but believe us, alone he won\u2019t get anywhere. If he isn\u2019t able to collaborate with your technical resources, nothing good will happen.<\/p>\n

That means he\u2019ll have to show a little humilty. \u00a0If he can\u2019t find the information he needs all by himself, well, he\u2019ll have to dare to ask that embarrassing technology 101 question that was holding him back, even if he looks a little dumb in front of the techies.<\/p>\n

But this also means telling those same technical experts what he expects of them, every time they review his documents, for example. He also has to be able to call them back to order when they wander off. All this and make sure to keep the working relationship agreeable for all.<\/p>\n

5. Agile<\/h4>\n

\"\"Projects are rarely carried out from A to Z without multiple changes and a few bumps along the road. Your technical writer will have to constantly update your documentation to new functionalities and interface changes or even maybe totally re-orient it.<\/p>\n

Maybe the documentation you were planning for final users now need to also support your distributors? Your writer should be able to quickly figure out which information needs to be added and adapt your documentation\u2019s tone, or maybe even its entire structure.
\nIf you find a professional with all these virtues, you certainly have a good technical writer! But if your writer is also able to take a big-picture view of your company and knows how to make your technical documentation work for your business objectives, become a marketing tool and improve your customer experience, well, then congratulations! You\u2019ve found an awesome<\/strong> technical writer!<\/p>\n","protected":false},"excerpt":{"rendered":"

So, you\u2019re ready? You\u2019ve taken a hard look and admitted that your technical documentation could be, well, better? It now seems obvious that asking your tech people to write user guides really is a bad use of their skills? You\u2019ve made a decision: You\u2019re going to hire a professional to produce technical documentation worthy of […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[23],"tags":[],"class_list":["post-407","post","type-post","status-publish","format-standard","hentry","category-technical-writing-and-documentation"],"acf":[],"_links":{"self":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts\/407","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/comments?post=407"}],"version-history":[{"count":0,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/posts\/407\/revisions"}],"wp:attachment":[{"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/media?parent=407"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/categories?post=407"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/lios.dev.creationsunivers.net\/en\/wp-json\/wp\/v2\/tags?post=407"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}