<?xml version="1.0" encoding="UTF-8"?><rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0" xmlns:cc="http://cyber.law.harvard.edu/rss/creativeCommonsRssModule.html">
    <channel>
        <title><![CDATA[Stories by Mister Technical Writer on Medium]]></title>
        <description><![CDATA[Stories by Mister Technical Writer on Medium]]></description>
        <link>https://medium.com/@mistertechnicalwriter?source=rss-48e06c18c2a4------2</link>
        <image>
            <url>https://cdn-images-1.medium.com/fit/c/150/150/1*22aG9dmeb4zh3hyKnjOa8w.jpeg</url>
            <title>Stories by Mister Technical Writer on Medium</title>
            <link>https://medium.com/@mistertechnicalwriter?source=rss-48e06c18c2a4------2</link>
        </image>
        <generator>Medium</generator>
        <lastBuildDate>Tue, 17 Nov 2026 18:40:48 GMT</lastBuildDate>
        <atom:link href="https://medium.com/@mistertechnicalwriter/feed" rel="self" type="application/rss+xml"/>
        <webMaster><![CDATA[yourfriends@medium.com]]></webMaster>
        <atom:link href="http://medium.superfeedr.com/" rel="hub"/>
        <item>
            <title><![CDATA[Mirror Revolutions: AI and Personal Computers]]></title>
            <link>https://mistertechnicalwriter.medium.com/mirror-revolutions-ai-and-personal-computers-8db52bf91e21?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/8db52bf91e21</guid>
            <category><![CDATA[technical]]></category>
            <category><![CDATA[ai]]></category>
            <category><![CDATA[technical-writer]]></category>
            <category><![CDATA[technical-writing-article]]></category>
            <category><![CDATA[technical-writing]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Thu, 31 Aug 2023 20:11:51 GMT</pubDate>
            <atom:updated>2023-08-31T20:11:51.443Z</atom:updated>
            <content:encoded><![CDATA[<p>Imagine for a moment you’re a technical writer for IBM in the 1970s and early 1980s. You create user manuals on electric typewriters. And the tidal wave of PCs begins in the 1980s.</p><p>Scary?</p><figure><img alt="Early PC" src="https://cdn-images-1.medium.com/max/300/0*CW6wQV8SRdeJZHCr.jpg" /></figure><p>No — Terrifying! How on earth will you keep your job?</p><p>[Sound familiar?]</p><p>The rise of AI today recalls his revolution. Like the dawn of the PC age, AI promises not just to reshape our tools, but to redefine our entire approach to work.</p><p>The 1970s and early 1980s remained in the era of mainframe computers. These behemoths, housed in vast air-conditioned rooms, were the epitome of computational power. Yet, they were inaccessible to most end users. PCs democratized this power. The vision of a computer on every desk was not just about possession but about empowerment. The personal computer heralded a golden age of productivity.</p><p>Much like the skeptics of today who warn of AI-induced unemployment, naysayers of the 1980s predicted that PCs would obliterate jobs. And yes, some roles did vanish. Ledger bookkeepers, for instance, were slowly replaced by spreadsheets. However, the rise of the personal computer didn’t lead to widespread unemployment. <em>On the contrary, it catalyzed a significant net increase in jobs.</em></p><p>The PC revolution created entire industries — software development, IT support, computer retail, and more. Beyond the direct job creation in these sectors, PCs enhanced productivity across industries. Real estate agents could now manage listings electronically; designers transitioned from drafting boards to digital design software; and writers moved from typewriters to word processors.</p><figure><img alt="Robot powered by AI" src="https://cdn-images-1.medium.com/max/300/0*tDxnqgdQSFxuzWqM.jpg" /></figure><p>This uptick in productivity led to economic growth. When tasks became easier and more efficient, businesses thrived, leading to more job opportunities. The ripple effect of the PC revolution spread far and wide.</p><blockquote>Fast forward to today. AI is on a similar trajectory. While concerns about automation replacing jobs are legitimate, history has shown that technological revolutions tend to create more opportunities than they eradicate. Just as the PC did, AI will unlock avenues previously unimaginable.</blockquote><p>New professions are emerging. AI ethicists, data scientists, AI trainers, and many more roles are cropping up. Existing professions, too, are evolving. Doctors are using AI to better diagnose diseases, marketers to understand customer preferences, and educators to personalize learning experiences.</p><p>What’s crucial to understand is that AI, much like the PC, is a tool. While it can automate certain tasks, it can’t replace the intricate web of human interactions, creativity, decision-making, and empathy that underpins most jobs. In many scenarios, AI will be a collaborator rather than a replacement.</p><p>As we face another technological revolution, it’s essential to remember that with change comes growth. And with growth comes prosperity. We can embrace AI with the same positive spirit that made the PC era so transformative.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=8db52bf91e21" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[What is Technical Writing and What Do Technical Writers Do?]]></title>
            <link>https://mistertechnicalwriter.medium.com/what-is-technical-writing-and-what-do-technical-writers-do-b483ce3af397?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/b483ce3af397</guid>
            <category><![CDATA[technical]]></category>
            <category><![CDATA[technical-writer]]></category>
            <category><![CDATA[technical-writing-course]]></category>
            <category><![CDATA[technical-communication]]></category>
            <category><![CDATA[technical-writing]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Tue, 01 Aug 2023 15:04:45 GMT</pubDate>
            <atom:updated>2023-08-01T15:04:45.482Z</atom:updated>
            <content:encoded><![CDATA[<iframe src="https://cdn.embedly.com/widgets/media.html?src=https%3A%2F%2Fwww.youtube.com%2Fembed%2FQsbSl-143MM%3Ffeature%3Doembed&amp;display_name=YouTube&amp;url=https%3A%2F%2Fwww.youtube.com%2Fwatch%3Fv%3DQsbSl-143MM&amp;image=https%3A%2F%2Fi.ytimg.com%2Fvi%2FQsbSl-143MM%2Fhqdefault.jpg&amp;key=a19fcc184b9711e1b4764040d3dc5c07&amp;type=text%2Fhtml&amp;schema=youtube" width="854" height="480" frameborder="0" scrolling="no"><a href="https://medium.com/media/f5334d0acfbcae17127300fa6cfb0fb7/href">https://medium.com/media/f5334d0acfbcae17127300fa6cfb0fb7/href</a></iframe><p>Many people wonder, what is technical writing and what do technical writers do?</p><p>Let’s dive into this.</p><p>When you purchase a new device or software, you often find a Getting Started Guide or a Help Guide.</p><p>These are products of technical writing, and it’s a technical writer’s job to create them.</p><p>While some technical writers work with technical audiences, most technical writers aim to simplify complex information for non-technical audiences. Developers have the skills to write technical documents, but they generally prefer not to. On the other hand, non-technical end users can’t create documentation for something they’re trying to understand.</p><p>That’s where technical writers come in.</p><p>Despite this crucial role, technical writing remains largely unknown to many. This could be due to its unglamorous, behind the scenes nature, and the fact that many technical writers prefer to stay out of the spotlight.</p><p>In my experience, software is the key area for technical writing. It’s estimated that in North America, about twenty percent of all technical writers work in companies that develop software. These companies often lead in creating innovative documentation methods, and they impact technical writing in other industries.</p><p>Even companies that don’t primarily deal with software often need comprehensive documentation for deploying, customizing, or upgrading their software. Such documentation includes installation guides, user manuals, admin guides, run books, and release notes.</p><p>However, technical writing isn’t confined to software.</p><p>Industries from finance to pharmaceuticals to defense employ technical writers. There are also specialized areas like policies and procedures, disaster recovery documentation, and more.</p><p>In conclusion, technical writing is a wide and varied field that plays a critical role in making complex information accessible and understandable.</p><p>Next time you’re using a guide or a manual, you can appreciate the work of technical writers behind it.</p><p>I hope this clarifies the important work that technical writers do.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=b483ce3af397" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[13 tips for sounding smart as a new technical writer]]></title>
            <link>https://mistertechnicalwriter.medium.com/13-tips-for-sounding-smart-as-a-new-technical-writer-b2f6f511c46?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/b2f6f511c46</guid>
            <category><![CDATA[tech-writing]]></category>
            <category><![CDATA[tech-writer]]></category>
            <category><![CDATA[technical-writing]]></category>
            <category><![CDATA[technical-writer]]></category>
            <category><![CDATA[technical]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Mon, 15 Aug 2022 21:42:56 GMT</pubDate>
            <atom:updated>2022-08-15T21:48:30.593Z</atom:updated>
            <content:encoded><![CDATA[<figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*z4ez9RrBLf-OyjucUtlHPw.jpeg" /></figure><p>We technical writers are communicators. Often the best communicators. And I don’t only mean writing. I mean by listening and responding in speech, email, and chat.</p><p>If we communicate poorly, how can technical colleagues trust we can help them with documentation?</p><p>If you’ve just become a technical writer, these tips may help you sound smarter than you feel. ;-)</p><p>Note: Unless otherwise noted, these observations are based on my direct experience.</p><ul><li>Don’t generalize. But if you do, admit you’re generalizing. “This may be a generalization, but I’ve noticed…” You’ll command respect from people who are careful about how they communicate. Technical people tend to be careful about how they communicate (of course, I’m generalizing :-)).</li><li>If you’re speaking of facts, be able to cite facts. If you’re speaking of rumors as if they’re facts? Don’t. There’s enough gossip and innuendo in the world. It will not make you sound smart.</li><li>If you’re speaking of your experience, try to say so. “In my experience” or “I’ve noticed” or “My impression has been” Try to avoid expressing spontaneous, random opinions unless you’re trying to be funny. (See next item on humor!)</li></ul><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*c6LvQ6srw6PT9Hd-1rdKBA.jpeg" /></figure><ul><li>Humor? You may be misunderstood. Be very careful about humor. (I tend to keep my mouth shut for the first few weeks to get a feel for a company’s culture, including humor.)</li><li>Never, never presume. Presumption is the kryptonite of technical writing. Start to presume and you’ll be taken less seriously.</li><li>If you don’t know, say you’ll look into it. Then investigate it. “I’m not certain, but I’ll look into it and let you know.” (Research is a vital part of technical writing.)</li><li>Don’t say stupid things. Things you know are factually untrue. <br> (Go to a bar and listen. You’ll find many stupid things said.)</li><li>Be direct by using indirection.<br> (It’s impolite to say, “You’re wrong.” But you can say “I believe that’s an incorrect statement.”)</li><li>Never respond with pique or small mindedness to rude or immature people. (I used to tell my kids to imagine rude classmates were “throwing up on themselves.”)</li><li>Don’t be hypocritical or use double standards.<br> If you’re accustomed to seeing people solely in categories or tribes, you’re bound to express bias in some unfortunate fashion. How much worse will this be if you believe yourself tolerant, accepting, and kind?<br> (Your colleagues may not buy your self-image!)</li><li>Don’t be a “nativist” to speakers of English as a foreign language.<br> (They typically speak more languages than you! Remember Joseph Conrad and Vladmir Nabokov, two of the greatest writers of the 20th century, did not speak English natively.)</li><li>When reviewing others’ work, lead with empathy. Start with the positives, even when there are few positives to note. Imagine you’re relating to your clone. How would you like your clone to feel? Especially: Don’t play power games when reviewing to soothe your hurt ego. (There’s typically someone better than you are out there.)</li><li>Always strive to be consistent, concise, and clear. This is whether you’re writing a document, responding to an email, or typing a chat. Don’t accept typos because you’re in a hurry. <br> <br>Hold yourself to the highest standards of written and verbal communication. And you will sound smart.</li></ul><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=b2f6f511c46" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[Bad Technical Writers]]></title>
            <link>https://mistertechnicalwriter.medium.com/bad-technical-writers-da2fa3ab206b?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/da2fa3ab206b</guid>
            <category><![CDATA[technical-communication]]></category>
            <category><![CDATA[humor]]></category>
            <category><![CDATA[comedy-writing]]></category>
            <category><![CDATA[technical]]></category>
            <category><![CDATA[technical-writing]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Fri, 12 Aug 2022 02:34:34 GMT</pubDate>
            <atom:updated>2022-08-12T02:39:47.915Z</atom:updated>
            <content:encoded><![CDATA[<p>How do I know about “Bad Technical Writers,” you ask?</p><ul><li>For over 22 years, I’ve worked with personalities resembling the <br>following “types.”</li><li>But, if I’m going to be perfectly honest, I’ve occasionally resembled <br>these portraits.</li></ul><p>This is meant to be fun and enjoyable.</p><p>Enjoy,</p><p>Bobby</p><blockquote>It is absurd to divide people into good and bad. People are either charming or tedious.</blockquote><ul><li>Oscar Wilde</li></ul><figure><img alt="" src="https://cdn-images-1.medium.com/max/448/0*iZEYnNNKnnnEANWK" /><figcaption>Please do not read the following if you lack a sense of humor. If you’re already annoyed, you may be sorely lacking a sense of humor. ;-)</figcaption></figure><h3>FONT FONDLERS</h3><p>Most of the following characters are “Font Fondlers” (coined by Andrew Plato*).</p><p>FFs are distinguished by <strong><em>how they elevate trivial matters into matters of existential significance</em></strong>. Interesting tidbit: Somehow they only fondle among other technical writers (as if they know nobody else cares).</p><p>EXAMPLES:</p><ul><li>Discussing font pairings (Serif and Sans Serif) until the lights go out.</li><li>Chatting about comma splices, split infinitives, and passive constructions.</li><li>Debating if Title Case or Sentence Case is better.</li><li>Arguing any arcane thing in Microsoft’s Style Guide.</li></ul><p><em>*Andrew, an engineer, claims that “Font Fondlers” contribute to a negative attitude toward technical writers among technical SMEs.</em></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*Ivfz0ZKbMS-ug68r" /></figure><h3>Donna Dogma</h3><p>In a previous life, Donna might have been a Jesuit priest and lawyer.<br>During the Inquisition.</p><p>True to her name, Donna is a “defender of the faith” — of wholesome, righteous technical writing. And an enemy of the sloppy, undisciplined cretins who dare find a whiff of ambiguity in style guides and grammar.</p><p>DONNA SAYS THINGS LIKE:</p><ul><li>Comma rules are rules for a reason!</li><li>Stick to the style guide!</li><li>Passive constructions are always wrong!</li></ul><p>DONNA’S FAVORITE PLACE:<br>Relaxing on the beach, reading a style guide.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*g8IR1cs2FLHD47rs" /></figure><h3>Kevin the Klever</h3><p>KK wants you to know he’s smart. Really smart. Not like “basic” technical writers.</p><p>Kevin believes the world would be a much better place if everyone adopted Open Source tools. Then ended Capitalism. But he’s a realist. One thing at <br>a time!</p><p>Kevin’s special skill is finding and displaying esoteric knowledge. The knowledge nobody else knows. He sees himself as a cultural repository of special knowledge.</p><p>KEVIN SAYS THINGS LIKE:</p><ul><li>Why does this company spend money on software?</li></ul><p>KEVIN’S FAVORITE PLACE:<br>On Reddit’s Technical Writing Subreddit, stomping on Newbs.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*P3qzkZht9qk4iCfK" /></figure><h3>Sam Silo</h3><p>Sam worked at Facebook. Then Amazon. Now Google. All his friends have worked at these three companies.</p><p>Sam says you need to know code to be a technical writer — or you’re not a technical writer. He says this because he’s worked in a silo of big tech companies his entire career. He’s vaguely aware that there are technical writers in other industries, but they’re so basic. I mean Policies &amp; Procedures? Really?!</p><p>SAM SAYS THINGS LIKE:</p><ul><li>You need to learn coding first as a technical writer.</li><li>There are technical writers in Minnesota?</li><li>Basic tech writers earn a fraction of what I make.</li></ul><p>SAM’S FAVORITE PLACE:<br>At any cafe in Silicon Valley, talking shop with other Silos.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*YZCbS81PlULSiZFh" /></figure><h3>Anna Administrator</h3><p>Anna thought technical writing was an easy, creative kind of thing, like writing poetry, which she does almost daily. She hates it when people expect her to know technical stuff. Aren’t the technical people supposed to write this stuff so I can format it?</p><p>Anna routinely attends meetings for which she’s not prepared and expects to be “hand held” like a child. Technical SMEs regard her as an admin assistant.</p><p>ANNA SAYS THINGS LIKE:</p><ul><li>That sounds really technical.</li><li>Am I supposed to know this stuff?</li><li>Want me to format it pretty for you?</li></ul><p>ANNA’S FAVORITE PLACE:</p><ul><li>At Starbucks, alone, reading e.e. cummings.</li></ul><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*BUeh6XK_J4fdudGw" /></figure><h3>HONORABLE MENTIONS: Non-Technical Writers Who Present as Technical Writers</h3><h3>Ed Engineer</h3><p>Ed minored in English twenty-five years ago in College. If you’re not impressed with this, you will be after he mentions it thirty times.</p><p>“I replace tech writers,” he tells you when you meet him.</p><p>Dang, that’s not a bad thing, you think, considering how badly every other technical SME in your organization writes. Most of them hate writing, too, and are delighted to help you complete their shambolic document stack.</p><p>So you save Ed’s document for last, confident you’ll need fifteen minutes to touch it up.</p><p>Fifteen hours later, on Sunday morning, you finish rewriting Ed’s mess. You spend another hour wondering how you’re going to soothe Ed’s ego on Monday (when you return his document lit up like a red Christmas tree from tracking).</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*jvf42fjshnkPJl_5" /></figure><h3>Doctor David</h3><p>Doctor David (PhD) is not a technical writer, but wants you to believe he was. You’re paying $40,000 dollars a year to learn technical writing at his university. You think he’s going to tell you the truth?</p><p>He’s an English professor and worked hard for his degree. Lived on peanuts until he made tenure.</p><p>That’s when the Chair of the English Department stuck a Technical Writing textbook in his hand and told him to teach it next year.</p><p>DD likes Chaucer and Shakespeare. He hates technical writing.</p><p>But he’ll teach it with a smile on his face because he knows you’re paying exorbitant amounts of money for your education.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1020/0*6XOWPXGQn3Gs6l6T" /></figure><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=da2fa3ab206b" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[The 3 types of documents in technical writing (with examples)]]></title>
            <link>https://mistertechnicalwriter.medium.com/the-3-types-of-documents-in-technical-writing-with-examples-21b1195c41ed?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/21b1195c41ed</guid>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Sun, 20 Mar 2022 00:00:29 GMT</pubDate>
            <atom:updated>2022-03-20T00:14:37.322Z</atom:updated>
            <content:encoded><![CDATA[<p>How many types of technical documents are there? Most articles online don’t list them. They mention guides, manuals, and procedures without connection to an audience. Other articles address specific subjects (e.g., “software documentation”).</p><p>Another way to look at documents? By intended <strong>audience</strong>. The following categorizes document types by audience.</p><h3>DOCUMENTS FOR NON-TECHNICAL AUDIENCES</h3><figure><img alt="Graphic of the word “Steps” on a sheet of paper" src="https://cdn-images-1.medium.com/max/1024/1*8ckJZxlkn9xv2DpbTnF78A.jpeg" /></figure><p>Most technical documents created by technical writers are not for technical audiences. Sounds strange, doesn’t it? But, in my experience, it’s true. I even wrote an <a href="https://becometechnicalwriter.medium.com/most-technical-writing-is-neither-e67e4d2bfda?source=friends_link&amp;sk=f2d70c5fbad3950bd00d1471055fa2be">article to support this thesis</a>.</p><p>Think about this: when I’ve worked with developers, I’ve noticed nearly all of them write — some very well, others, passably so.</p><p>Many “devs” are used to “writing as they go,” or documenting their coding, which can sometimes be a more efficient workflow than blocking off time for writing.</p><p>Sometimes devs have no choice but to create their own documentation because a dedicated technical writer can be a luxury, especially for small to medium-sized businesses.</p><blockquote>What about non-technical end users? They cannot write the documentation they rely on for help!</blockquote><p>Example document for a non-technical audience</p><p>A good example of a document (excerpt) for a non-technical audience would be this <a href="https://support.apple.com/en-us/HT204523">Apple Watch user guide</a>:</p><h4>Start a workout</h4><ol><li>Open the Workout app.</li><li>Find the workout that best matches what you’re doing. <a href="https://support.apple.com/kb/HT207934">Learn more about each workout type</a>.</li><li>To set a goal, tap the More button next to the workout that you want to do. To skip setting a goal, tap the workout.</li></ol><figure><img alt="" src="https://cdn-images-1.medium.com/max/450/0*DkAc2a-q5r1-RoXB.png" /></figure><p>4. Wait for the three-second countdown. To skip the countdown, tap the screen.</p><h4>Clues you’re reading a non-technical document</h4><p>A few clues that this example is a non-technical document include:</p><blockquote>the simple word choice and phrasing</blockquote><blockquote>the large graphics</blockquote><h4>Other examples of documents for non-technical audiences</h4><ul><li>End-user guides</li><li>Knowledge articles</li><li>FAQs</li><li>Policy and procedure documents</li></ul><h3>DOCUMENTS FOR TECHNICAL AUDIENCES</h3><figure><img alt="Computer display" src="https://cdn-images-1.medium.com/max/1024/1*V_9YbY81qDz2-2pAxd8Y4A.jpeg" /></figure><p>“Technical” technical writers are often embedded with software development teams. They need to know the language (code) the developers are implementing.</p><p>Code in technical documents can be copied and pasted into an application under development. Alternatively, code can be used for integrating multiple applications or to configure a database. If the code is wrong, it might break the application. If you know the syntax of Java or Python code, you’ll be better prepared to spot coding errors.</p><h4>Example of a document for a technical audience</h4><p><em>An example of a technical document includes this course content on </em><a href="https://idratherbewriting.com/learnapidoc/"><em>‘Documenting APIs’ from Tom Johnson</em></a><em>:</em></p><p><strong><em>YAML is a superset of JSON</em></strong></p><p><em>For the most part, YAML and JSON are different ways of structuring the same data. Dot notation accesses the values the same way. For example, the Swagger UI can read the openapi.json or openapi.yaml files equivalently. Pretty much any parser that reads JSON will also read YAML. However, some JSON parsers might not read YAML because there are a few features YAML has that JSON lacks (more on that </em><a href="https://idratherbewriting.com/learnapidoc/pubapis_yaml.html#yaml_specific_features"><em>below</em></a><em>).”</em></p><h4>Clues you’re reading a technical document</h4><p>A few clues that you have a technical document in front of you include:</p><blockquote>the highly specialized words</blockquote><blockquote>the lack of large graphics</blockquote><h4>Other examples of documents for technical audiences</h4><ul><li>Configuration guides</li><li>Integration guides</li><li>Administrator guides</li></ul><h3>DOCUMENT HYBRIDS</h3><p>And, of course, we can write documents to satisfy both technical and non-technical audiences — these try to strike a balance and often have a blend of the features above.</p><p>My favorite example: a Disaster Recovery Plan (DRP). During a disaster, there may be technical systems or applications that need to be restarted by non-technical staff because of technical personnel being unavailable (because of the disaster).</p><h4>Example of a hybrid document</h4><p>I like this <a href="https://www.veritas.com/support/en_US/article.100033528">disaster guide excerpt from Veritas</a> — note the specialized wording alongside the large graphics:</p><p><em>“The problem: Steps to create a Simplified Disaster Recovery (SDR) ISO and perform a server recovery using the SDR CD or ISO.</em></p><p><a href="https://www.veritas.com/support/en_US/article.100033528#Gather%20Log%20Files%20for%20Tech%20Support"><em>Gather log files for technical support if recovery using SDR fails.</em></a><em><br> <br> After the first Simplified System Protection (SSP) or SDR enabled backup, an alert is displayed: ‘Simplified Disaster Recovery Disk is not created’.</em></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*q3Vbz1i0Ie8hP6W0.JPG" /></figure><p><em>Click on the Backup Exec (BE) icon. Choose Configuration and Settings, and then Create Disaster Recovery Disk.”</em></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/668/0*OXYQeFZy-VIDIHzU.jpg" /></figure><p>So here you have it, the three technical document types by intended audience — a helpful way of categorizing the outputs from your technical writing mission, should you choose to accept.</p><p><strong>References</strong></p><p>Documenting APIs (Tom Johnson)<br> <a href="https://idratherbewriting.com/learnapidoc/">https://idratherbewriting.com/learnapidoc/</a></p><p>Apple Watch User Guide<br> <a href="https://support.apple.com/en-us/HT204523">https://support.apple.com/en-us/HT204523</a></p><p>Veritas Disaster Guide<br> <a href="http://www.veritas.com/support/en_US/article.100033528">www.veritas.com/support/en_US/article.100033528</a></p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=21b1195c41ed" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[Working with SMEs]]></title>
            <link>https://mistertechnicalwriter.medium.com/working-with-smes-a6bed90c56a0?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/a6bed90c56a0</guid>
            <category><![CDATA[writing]]></category>
            <category><![CDATA[technical-writing]]></category>
            <category><![CDATA[technical]]></category>
            <category><![CDATA[technical-writer]]></category>
            <category><![CDATA[technical-analysis]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Mon, 28 Feb 2022 00:07:05 GMT</pubDate>
            <atom:updated>2022-02-28T00:50:03.497Z</atom:updated>
            <content:encoded><![CDATA[<p>I’m convinced that how we interact with colleagues is just as important (maybe more important) to our job security than our actual work. We can do brilliant work but if we’re jerks, it’s “Exit, stage left!” Alternatively, we can do adequate work, but if we’re genuinely helpful and cooperative, others encourage us to do better, as friends or even champions. In 2022, “soft skills” are more important than ever.</p><p>So what’s a SME and what’s important about working with them?</p><p>SME, pronounced “SMEE”, is an acronym for “Subject Matter Expert.” This term is used in many industries. If you work as a tech writer, you’re going to hear this term (sometimes pronounced: “S-M-E”) a lot.</p><h3>Who are SMEs?</h3><p>SMEs are the brain trust of an organization. They are where knowledge and wisdom live. It’s imperative that we capture their knowledge in documents so that the company can optimize its operations.</p><p>By doing so, we ensure that the SME doesn’t become a “single point of failure” (to use a Business Continuity term). Without this, if something happens to that person, the firm will suffer harm — sometimes lasting harm.</p><h3>A metaphor for the relationship?</h3><p>SMEs are the prime knowers and doers in the organization. Technical writers document the SMEs’ “what” and “how.”</p><p>The illustration (below) depicts a technical writer documenting the work of two SMEs on an automobile.</p><p>What does this technical writer need to know?</p><p>● He, at least, needs to know the names of tools, parts, and any affected systems, so he can document what the SMEs are doing. (What if he were to interrupt the SMEs while they’re working to ask for the name of a tool or a part? That would not help the working relationship!)</p><p>What does the SME need to know?</p><p>● The SME needs to know how to fix the car (and actually perform the work). And, by communicating with the technical writer, he can help offload the documentation required for his job.</p><figure><img alt="Technical writer working with two SMEs on a car" src="https://cdn-images-1.medium.com/max/936/1*VPr88SJJtFls08PKZlaYWw.png" /><figcaption>Technical writer at work</figcaption></figure><p>How do SMEs view technical writers?</p><p>Most technical people are fortunate to have the support of <em>effective</em> technical writers. Without technical writers, documentation will be on them if they don’t get this type of help.</p><p>But, some SMEs may not have had positive experiences in the past. Some technical writers expect documents to be completed so they can add special fonts and formatting flourishes. Andrew Plato, an engineer who became a technical writer, called these technical writers “font fondlers.”</p><p>YOU are a writer. Editor. Proofreader. And publisher. You’re not a “font fondler.”</p><h3>TYPES OF SMEs IN THE WILD*</h3><p>* These caricatures are used to illustrate certain tendencies. They should not be taken literally.</p><p>These portraits are based on 21 years of direct experience. I’d be doing you a disservice to suggest SMEs are generally helpful and supportive of your work. However,</p><p>the tone of your work with SMEs is likely to depend on your company’s management and the value they put on good documentation practices.</p><p><strong>Unicorn SME</strong>: Available, pleasant, and consistently helpful. (Rumored to exist in the wild.)</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/338/1*zjGPC-PyxseBnmDHsB10jg.png" /><figcaption>Rumored to exist in the wild…</figcaption></figure><p><strong>Regular SME</strong>: Sometimes available, pleasant, and helpful. Sometimes abrupt, overstressed, and avoidant. (A sizeable majority.)</p><p><strong>Superior SME</strong>: Believes you should bow or genuflect before speaking. Secretly wishes you’d make the coffee or serve them breakfast to underscore their superior value to the company (and the world). Compensate for whatever inferiority troubles them by snubbing you, behaving rudely, or just being a regular pain in the derriere. (Endangered, but still visible in the wild.)</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/358/1*cwdZOEj6YF2eR66dHcvWDg.png" /><figcaption>Superior SME in action</figcaption></figure><p><strong>Chicken SME</strong>: Usually timid, though that’s the last thing they want you to see in them. Terrified of sharing their knowledge and “endangering” their jobs (by making themselves replaceable). Will find a thousand ways to avoid helping you document what they know. (Endangered, but dangerous when confronted with their greatest fear.)</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/284/1*duDoW2ot_ihrUOQqqUJQ3g.png" /><figcaption>Chicken SME fleeing the scene (of course)</figcaption></figure><p>In fairness, SMEs are often overworked, stressed, and short of time.</p><p><strong><em>Whether we get the information we need usually depends on our behavior with them.</em></strong></p><h3>HOW TO HELP SMEs BE THEIR BEST SELVES</h3><h3>Listen actively</h3><p>It’s a cliche but so true. And a good SME can listen so they’ll appreciate your attentiveness.</p><p>Tips for listening actively:</p><p>● Repeat the last few words of what a person says to you (mirror it back to them).</p><p>● Paraphrase what you’ve heard.</p><p>● Always take selective notes (do not take word-for-word notes).</p><h3>Set expectations on deliverables and deadlines</h3><p>You’re going to be held to delivering on time so recruit them by sharing your timelines and asking them “Do these dates seem undoable (or “unrealistic”) to you?” They will nearly always say “Of course not” because people tend to feel much more secure saying “no” than saying “yes.”</p><h3><strong>Make learning their language your mission</strong></h3><p>By language, I mean terms and concepts. Know their vocabulary because you’re going to be using it. After all, the effective use of these words is your domain of expertise.</p><p>If you resist learning their language, you may become defensive of your ignorance and not very helpful to them.</p><p>Respect<strong><em> for them and their time usually translates into them respecting your work.</em></strong></p><h3>Never presume</h3><p>If you catch yourself frequently saying “Oh, I thought that…” to a SME, you might be on a presumption roll. This usually means you’re not as prepared as you might be, which leads to:</p><h3>Always be prepared before speaking to SMEs about their “S”</h3><p>Do your homework before meetings and interviews. Don’t come unprepared.</p><h3>Never start from scratch</h3><p>SMEs leave tracks. Of the hundreds of documents I’ve worked on, only a few were built “from scratch.” There is (almost) always a draft, or outline, or even a bunch of bullets collected in the past — even if it’s an outline written on a cocktail napkin! It’s better than starting from scratch. Use what already exists to your advantage</p><h3>Match their preferred communication style</h3><p>Try different modes of communication. (Email instead of chat. Maybe a phone call.) People respond differently to different forms of communication. You can ask them if they have a preference or just try different types to see what works best.</p><h3>Impress with your interviewing skills</h3><p>Again, do your homework. (Never come unprepared.) There’s probably no greater an insult than wasting a SME’s time by being unprepared.</p><ol><li>Have questions ready. Even if they’re basic. Writing them down will help you stay focused and will impress the SME.</li><li>Record when possible. I use Otter.ai when I can. But make sure you check with your SME first. You can say you’ll delete it shortly after the meeting. (If you say it, do it.)</li><li>Send recap notes if possible — allow them to view or respond to your notes. This is a good time to ask for clarification on anything you’re concerned you may not have captured (you can use bold red to highlight the section in the notes).</li></ol><h3>DEALING WITH CHALLENGING SMEs</h3><p>There are difficult SMEs. Some may be at a bad juncture in their job or personal life. Some are just jerks.</p><p>Resistance can take the form of:</p><p>● Not giving you time.</p><p>● Missing or postponing meetings (avoidance).</p><p>● Not responding to specific, reasonable requests.</p><p>Methods for handling this include:</p><ol><li>(If you haven’t already) confirm you have your manager’s support (so you can escalate if necessary).</li><li>Sell them with a plain-spoken, commonsense explanation that you can save them time and stress by helping with documentation. <br> “<strong><em>What if I could save you hours of time on documentation that the firm requires</em></strong>?”<br> (Who’s going to argue with that?)</li><li>Try to be both patient and persistent. Are they being dismissive? Document every unhelpful interaction in a calm, objective manner in a separate document. This will help should you need to escalate.</li><li>After repeated avoidance, escalate to your manager. This is the “nuclear” option and should be your last resort.</li></ol><h3>GOING ABOVE AND BEYOND</h3><p>If you have the time and patience, or if you sense benefits to being super keen, you can do the following prior to working with a SME:</p><p>● Look up their LinkedIn profile. Scan their work history, publications, and any personal references. Most people love talking about their favorite subject (themselves). If you can plan a few “break-the-ice” questions about their background, even better. But your questions need to be sincere.</p><p>● Collect reference material (in your quest to master their terms/concepts). Tell them about your efforts to understand (software development, or virtual servers, or digital security, etc…). Then ask them if they can suggest a “bible” or single source of information that might be helpful. Again, your interest has to be sincere.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=a6bed90c56a0" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[9 Common Mistakes When Seeking Your First Technical Writing Job]]></title>
            <link>https://mistertechnicalwriter.medium.com/9-common-mistakes-when-seeking-your-first-technical-writing-job-82a78731ae47?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/82a78731ae47</guid>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Tue, 31 Aug 2021 20:53:31 GMT</pubDate>
            <atom:updated>2021-09-01T00:46:04.881Z</atom:updated>
            <content:encoded><![CDATA[<h3><a href="https://becometechnicalwriter.medium.com/9-common-mistakes-when-seeking-your-first-technical-writing-job-82a78731ae47?source=your_stories_page-------------------------------------">9 Common Mistakes When Seeking a First Technical Writing Job</a></h3><p>1) Focusing on a Full-Time Position</p><p>We all know the ideal partner doesn’t exist, that life does not follow a Disney script, but many of us persist in the illusion that a perfect partner-for-life is out there somewhere.</p><p>Likewise, we often persist in believing that a perfect full-time position awaits us that will nourish our amazing talents and gently lift us up to successively responsible positions in the organization.</p><p>BUNK!</p><p>Idealizing employment from ANY company today is a fool’s game. Unless your name is Mark Zuckerberg. Then you can say the company treats you like royalty.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*o8cw1MmeseG8pUisHCNlkw.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@markusspiske?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Markus Spiske</a> on <a href="https://unsplash.com/s/photos/king?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>About a decade ago, companies found the antidote to hiring the wrong person: Temp to Perm positions. These are contract positions that convert to full-time positions if everyone is on board (the companies have agreements in place with staffing companies to smooth the transition).</p><h4>A Great Model</h4><p>A temp-to-perm (also called “try before you buy”) role is a way for both you and a company to try each other on for size. Companies vary so much in culture, pay, benefits, and overall health that it takes a while to understand whether it’s worth investing years of your life to working there.</p><p>And companies avoid the risks and costs of getting it wrong, which can be immense. After some month, managers understand what you offer and what your trajectory in the company might look like. This is not knowledge you can gain over a few hour-long interviews.</p><p>When I started in 2000, the world was split between full-time employees and contractors. We would interact knowing that in nine months, or a year, we’d have to say goodbye. Now a good contractor, even when not engaged formally as a temp-to-perm hire, is often evaluated as a fit and sometimes offered a position.</p><p>I advise anyone looking for their first technical writing role today to prioritize their search by:</p><ul><li>Contract positions</li><li>Freelance (piece) work</li><li>Full-time positions</li></ul><h4>2) Ignoring the Elephant in the Room</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Bp-S2zcihtf4S-bFgicGZw.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@mana5280?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">mana5280</a> on <a href="https://unsplash.com/s/photos/elephant-in-the-room?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>Imagine Al Pacino interviewing you. He leans across the small table, about a foot away from your face, and asks:</p><blockquote>You have ZERO experience. Why on earth should my company hire you?</blockquote><p>You take a deep breath — this IS Al Pacino — and you say “<strong>Because my cumulative experience matches what you’re looking for.</strong>”</p><p>Companies are NOT SEARCHING FOR BEGINNERS. And if you’ve graduated college and/or have worked a few years in a professional capacity, YOU ARE NOT A BEGINNER.</p><p>Most companies looking for 1–2 years’ experience will consider you as long as your prior “cumulative” experience matches their requirements.</p><p>It’s spinning, it’s putting your best foot forward, placing yourself in the best light, or shameless self-promotion, but you must be able to do this if you’re going to win that first technical writing position.</p><h4>True Story</h4><p>I had a woman enroll in my course (<a href="https://becometechnicalwriter.com/">https://becometechnicalwriter.com</a>) and begin to interview immediately. She had a background as a marketing writer, so she had to “spin” her experience for a technical writing role.</p><p>She got the role long before she finished the course!</p><h4>3) Blended Portfolios</h4><p>If you send me a link to your portfolio, I want a clean site (showing you grasp the basics of UX design) with technical writing samples. Add a brief bio and contact form.</p><h4>The Formula:</h4><p>Polished Samples + Brief Bio + Contact Form = perfection.</p><p>I don’t want to be distracted by your hobbies or whatever other skills/talents you may have.</p><p>If you need a basic introduction to design, see Steve Krug’s book “<strong>Don’t Make Me Think</strong>.”</p><p>You may LOVE skiing, so you add it to your portfolio.</p><p>But what if I broke a leg skiing and hate it? Do I really want to sit around listening to you talk about your recent trip as I relive my snow-encrusted misery?</p><p>Likewise, personal pursuits like Tarot Cards and your cats. I may think Tarot Cards cool as heck, but what does it mean when you’ve included this in your bio information (“hobbies”)? Are you a witch or warlock too? And a good witch/warlock <br>or bad? ;-)</p><p><em>Don’t give people a reason to prejudge you.</em></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Wsp2BCBUxds8ayfPXvFtcQ.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@vivalunastudios?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Viva Luna Studios</a> on <a href="https://unsplash.com/s/photos/tarot-cards?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>Please do not list:</p><ul><li>Personal stuff (Tarot Cards/cats)</li><li>Other professional pursuits (e.g., graphic design/producing videos)</li></ul><h4>4) Mediocre Samples in a Portfolio</h4><p>Your portfolio is for showing off.</p><p>I never had “perfect” samples in my portfolio, because they were extracts of documents I “anonymized” to conceal privileged information. Whether it was a technical diagram or the contents page to a user guide: it showed I knew what I was doing.</p><p>If you have complete control of your samples — if you’re creating them for the portfolio, try to make them as perfect as possible. Anything irregular, whether typos or formatting issues, will not be a good look.</p><p>You can usually find people on <a href="https://www.writethedocs.org/">Write the Docs’</a> Slack forum (channel: #<strong>doc-reviews</strong>) to review your samples.</p><h4>5) Unfocused LinkedIn Profile</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Dd9s2Y2TxTk6YhiyJFgqkg.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@gregbulla?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Greg Bulla</a> on <a href="https://unsplash.com/s/photos/linkedin?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>Like “Blended Portfolios,” this is a common issue.</p><p>Keep it professional. Keep it focused on your role: Technical Writing.</p><p>If your LinkedIn title says “Copywriter” or “Professional Writer,” you might be passed over for an interview.</p><p>Companies shopping for you might Google your name, for sure, but they’re not likely to dig for what you put up in Pinterest five years ago. Nobody has the time for that.</p><p>What’s their #1 destination?</p><p>LinkedIn.</p><h4>Make LinkedIn Sparkle</h4><p>Write the intro, show it to your friends, clean up your resume, show it to your friends. If you have a little money, spend it on a writer who specializes in LinkedIn (look on Upwork or Fiverr).</p><p>PS: My LinkedIn profile is lousy, because I’m not currently open to new offers for work as a technical writer.</p><h4>6) Not Scrubbing Social Profiles</h4><p>Open an Incognito tab (Chrome) or Private window (Firefox) and Google your name. If your name is unique and you’re a “Twitter Thunderer,” clean up that profile (remove your photo, your real name, etc….).</p><p>No companies want to dig up dirt, but if it’s out there in the open — if you’ve got shirtless pics on a balcony in the French Quarter during Mardi gras, then congratulations on a social life. But don’t pin it to the top of your profile.</p><p>Same with posts expressing strong opinions. It’s a free country, right? Companies are also free not to hire someone who tweets or posts divisive material.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*p-pj024Ur2udyyh1XaIGXg.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@merakist?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Merakist</a> on <a href="https://unsplash.com/s/photos/social-media?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><h4>True Story</h4><p>Many years ago, when I was supporting a family of four, I had a guy hassling me. One night, I dreamed I should look up his name. It was a long, 16-letter Polish name, so it was easy to find.</p><p>I discovered he had a federal conviction for fraud. When I told him what I knew, he stopped hassling me!</p><h4>7) Failure to Prep for Interviews</h4><p>I recently hired two technical writers. I met about ten candidates. Of the ten, at least six were woefully under-prepared to interview.</p><p>These were senior technical writers.</p><p>You need to know the following:</p><ul><li>Every job has its typical questions. You’ve got to know what they ask so you can be prepared and not “wing it.”</li><li>You need to know about the company. Spend at least ten minutes on the company website. (How can you say you want the job if you haven’t done a minimal amount of research on the company?)</li><li>You need to understand the requirements or be ready to ask clarifying questions about those you don’t understand.</li></ul><h4>8) Lousy Interviewing Skills</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*xIdT7Nf4p8H84R0C02CSiw.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@wocintechchat?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Christina @ wocintechchat.com</a> on <a href="https://unsplash.com/s/photos/interview?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>A good interview is like a chat at a coffee table. It’s not like a professor at a lectern quizzing a student below.</p><p>Assuming you’re prepared (see previous item), treat it like you care. Especially now, when nearly every interview is a remote video call.</p><p>It seems silly to say this, but don’t become overly relaxed because you’re at home on video.</p><ul><li>Wear a nice top.</li><li>Make sure your background is not distracting (or use a fake background).</li><li>Avoid interviewing on your phone. If you must use your phone, keep it stationary.</li><li>Don’t wait till the end to ask questions. If you see a need for clarification, ask. A good interviewer will appreciate your question.</li><li>Want the job? Tell the interviewer at the end: “I think I’d be a great fit for this position and can really help you out. I definitely want this job.”</li></ul><h4>9) Undisciplined, Disorganized Job Search</h4><p>It’s a tired old cliche. But it’s true. Looking for a job is a “numbers game.”</p><p>It’s also a job — <em>you’re hiring you</em> to help yourself. So hold yourself accountable.</p><p>My course (<a href="https://becometechnicalwriter.com/">https://becometechnicalwriter.com</a>) has a job search checklist, because it’s so important to hold ourselves accountable.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*MgS2DYaavscQwbVYhHk4FA.jpeg" /><figcaption>Photo by <a href="https://unsplash.com/@theeastlondonphotographer?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Ehimetalor Akhere Unuabona</a> on <a href="https://unsplash.com/s/photos/disorder?utm_source=unsplash&amp;utm_medium=referral&amp;utm_content=creditCopyText">Unsplash</a></figcaption></figure><p>PS:</p><p>If you have an undisciplined, disorganized job search and you’re hanging around the wrong people, they’ll listen to you complain about “how hard the job search” is. This will have NOTHING to do with the actual market in the real world.</p><p>The right people will tell you it’s a numbers game and a job in itself. And to get more disciplined and organized.</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=82a78731ae47" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[The 10 Most FAQs About Technical Writing]]></title>
            <link>https://mistertechnicalwriter.medium.com/revisiting-tom-johnsons-10-most-faqs-about-technical-writing-2c17de86f05a?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/2c17de86f05a</guid>
            <category><![CDATA[technical-writing-course]]></category>
            <category><![CDATA[technical-writing-online]]></category>
            <category><![CDATA[technical-writing-faqs]]></category>
            <category><![CDATA[technical-writing-article]]></category>
            <category><![CDATA[technical-writing]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Mon, 30 Aug 2021 02:48:47 GMT</pubDate>
            <atom:updated>2021-08-30T19:17:09.488Z</atom:updated>
            <content:encoded><![CDATA[<p><strong>6 MINUTE READ</strong></p><h3>Introduction</h3><p>This is my take on a nearly 10-year-old post, “​<a href="https://idratherbewriting.com/2013/01/17/top-10-most-frequently-asked-questions-about-technical-writing/">Top 10 Most Frequently Asked Questions,</a>” (About Technical Writing) by Tom Johnson. Most of what Tom says in his original post is valid today.</p><p>His blog, <a href="https://idratherbewriting.com/">I’d Rather Be Writing</a>, is the most visited blog by a technical writer. (<a href="https://idratherbewriting.com/blog/technical-writing-course-become-a-technical-writer-bobby-kennedy/">My online course was featured not too long ago</a>.)</p><p><strong>1. What technical writing tools should I learn?</strong></p><p>Tools! Tom begins with the always topical list of tools. He recommends learning a few programming languages, then lists about a dozen tools to learn.</p><p>ME: INFORMATION OVERWHELM!</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*XdoNtpaycdk3Rcwm" /><figcaption>Photo by <a href="https://unsplash.com/@markusspiske/portfolio/?utm_source=heights_platform&amp;utm_medium=referral">Markus Spiske</a> on <a href="https://unsplash.com/?utm_source=heights_platform&amp;utm_medium=referral">Unsplash</a></figcaption></figure><p>I believe Tom’s second paragraph, where he mentions examining<a href="https://indeed.com/"> https://indeed.com</a> to identify a “common trend in tools required” is spot on.</p><p>Your region and the industry you prefer to work in will dictate much of the choice of tools.</p><p>By all means, download and become familiar with technical writing tools, but let’s be realistic. You’re not learning a dozen tools to get a job in technical writing. You learn a dozen tools after years as a technical writer.</p><p><strong>2. Should I get a technical writing degree or certificate?</strong></p><p>Tom recommends getting a technical communications degree if you’re at that place in your life.</p><p>I cannot recommend a technical communications degree. I’ve spoken directly with a few people and I’ve heard plenty of stories anecdotally that these courses do not prepare you to work as a technical writer.</p><p>In North America, I would recommend a technical degree or a Liberal Arts degree if the school has a rigorous, demanding program (most don’t).</p><p>Tom adds that:</p><blockquote>Few professional technical writers have degrees or certificates specifically in technical communication anyway.</blockquote><blockquote>Instead, focus your efforts in developing a strong portfolio with examples that demonstrate your knowledge and skills.</blockquote><p>I agree with these two points 100%.</p><p>Since Tom’s article, online learning has taken off (along with “micro-credentials” generally). This is why <a href="https://becometechnicalwriter.com/">Become a Technical Writer</a> works for so many people.</p><p><strong>3. How do I get a job in technical writing without experience?</strong></p><p>Tom’s answer, quoted below, is spot on.</p><blockquote>If you don’t have any experience, volunteer your technical writing skills with an open source application, such as WordPress. For example, you could rewrite or add information in the <a href="https://codex.wordpress.org/">WordPress Codex</a>. Alternatively, you could create instructions for a product you use, such as your phone or camera.</blockquote><blockquote>The exact product doesn’t so matter much. Interviewers will be interested to see your writing style, your ability to articulate complex concepts, your mastery of advanced tools to author the information, your sense of organization and detail, and more.</blockquote><p>I would add that there are thousands of new software applications looking for help. They’re produced by software teams who do not write English well, so they struggle to find affordable help (most new companies are not sitting on a pile of cash).</p><p>Two locations to find these apps:</p><p>​<a href="https://appsumo.com/">https://appsumo.com</a>​</p><p>​<a href="https://angel.co/">https://angel.co</a>​</p><ul><li>Choose an application.</li><li>Examine its website.</li><li>See typos? Most likely they’re not native speakers.</li><li>Download a trial application (most do not require your credit card).</li><li>Note gaps in documentation (Knowledge Articles? Getting Started Guide? End User Guide?)</li><li>Create a sample and send it on to them. Ask them if they’d like more. They may ask “how much.” Make them an offer. They need help and it’s nice to be paid for new work.</li></ul><p><strong>4. I’m interested in technical writing, but isn’t it boring?</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*njwUKbF53oH_so1K" /><figcaption>Photo by <a href="https://unsplash.com/@siavashghanbari/portfolio/?utm_source=heights_platform&amp;utm_medium=referral">Siavash Ghanbari</a> on <a href="https://unsplash.com/?utm_source=heights_platform&amp;utm_medium=referral">Unsplash</a></figcaption></figure><p>Tom and I agree in the main that technical writing is not boring. But I’m less emphatic about it.</p><p>I’ve found some technical writing can be mind-blowingly, soul-suckingly, teeth-shatteringly boring.</p><p>Some examples:</p><ul><li>Creating/editing template styles</li><li>Reformatting long documents (you didn’t create)</li><li>Creating indexes (not so common anymore)</li></ul><p>Whenever there’s rote work involved, I get bored. A few of my antidotes:</p><ul><li>Blast music into my ears or</li><li>Chunk up the work and try to beat my estimated time for each chunk (i.e., gamify it).</li></ul><p>Tom adds a fantastic note about how interesting the work environment can be (not so relevant in the current time of COVID):</p><blockquote>Besides using these creative skills, you’ll be immersed in an environment full of interaction designers, engineers, quality assurance testers, project managers, analysts, corporate communications teams, and more. In short, IT departments can be energetic, cool places to work.</blockquote><p><strong>5. Would I be a good technical writer? I don’t have a background in technology or writing.</strong></p><p>Tom lists the attributes of good technical writers in a bullet list.</p><p>It’s a good list (see below).</p><p>But he qualifies it with:</p><blockquote>​You will be a good tech writer if you have any of the following qualities​</blockquote><p>My take:</p><p>I think you’ll need to have more than a single quality to be a successful technical writer. I find an interest in technology and a strong desire to write to be key.</p><p><strong>Tom’s List of Technical Writing Qualities</strong></p><blockquote>· You’re a good problem solver.</blockquote><blockquote>· You’re patient (e.g., when you run into technical problems, you don’t throw your mouse across the room).</blockquote><blockquote>· You’re tech savvy.</blockquote><blockquote>· You’re a gadget person.</blockquote><blockquote>· You like interviewing and talking with people.</blockquote><blockquote>· You like writing and language.</blockquote><blockquote>· You like figuring out how things work.</blockquote><blockquote>· You like layout, design, and visuals.</blockquote><p><strong>6. I don’t have money to buy the tools, but all technical writer jobs seem to require knowledge of these tools.</strong></p><p>Tom lists (free) open source software, academic licensing, and trial versions.</p><p>Agree 100%</p><p><a href="https://www.techsmith.com/screen-capture.html">Techsmith’s Snagit</a> has a 30 day trial they extend to 60-days upon request. Many software companies will extend a trial.</p><p>Thirty days is more than enough time to become familiar with a tool if you budget your time wisely (don’t download a dozen at once).</p><p><strong>7. Could I get a job as a remote tech writer working from home?</strong></p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/0*FTPojTOIEgMrLSsB" /><figcaption>Photo by <a href="https://unsplash.com/@tspoonphoto/portfolio/?utm_source=heights_platform&amp;utm_medium=referral">Tina Witherspoon</a> on <a href="https://unsplash.com/?utm_source=heights_platform&amp;utm_medium=referral">Unsplash</a></figcaption></figure><p>Tom’s answer: as a newbie, typically not.</p><p>My answer in the time of COVID: YES!</p><p>Emphatically yes.</p><p>This is one of the best times to win a contract for 3 or 6 months at a company 500 miles or even 10,000 miles away!</p><p><strong>8. What exactly do technical writers do?</strong></p><p>Tom’s answer, pasted below, is a very good list.</p><p>One conspicuous miss: <strong>Policy and Procedure</strong> (“P&amp;P”) documentation (not product related). I’ve created Disaster Recovery and Business Continuity documents that are all about P&amp;P.</p><p><strong>Tom’s List of Technical Writing Tasks:</strong></p><blockquote>· Explore products and analyze requirements data enough to become an expert about the product.</blockquote><blockquote>· Interview and meet with subject matter experts in regular meetings and one-on-one situations to ask questions and learn more about products.</blockquote><blockquote>· Create instructions on how to use software applications and hardware products.</blockquote><blockquote>· Create illustrations, diagrams, and other visuals that explain technical concepts.</blockquote><blockquote>· Record video tutorials that show how to use technical products.</blockquote><blockquote>· Relay user feedback to product teams on how to improve the products, whether that feedback comes through usability testing, training, or other user immersion.</blockquote><blockquote>· Create elearning courses and simulations for users to learn products.</blockquote><blockquote>· Create technology how-to articles for marketing efforts to increase awareness and adoption of technology products.</blockquote><p><strong>9. I have an assignment to interview a technical writer. Can I send you my list of questions?</strong></p><p>Tom responds that he doesn’t have time for this. He suggests going on Twitter using hashtag #techcomm and asking a technical writer.</p><p>I would add the <a href="https://www.reddit.com/r/technicalwriting/">Technical Writing forum </a>on Reddit as well as <a href="https://www.writethedocs.org/">Write the Docs</a> Slack Channel (Slack link is near the top of the page).</p><p><strong>10. How can I get a job as a technical writer?</strong></p><p>Tom’s first sentence rings true (that the jobs are much easier to find).</p><blockquote><em>​​Getting your first job as a technical writer is usually the hardest job to get, but the jobs once you’re established in the field become much easier.</em>​</blockquote><p>I’ve pasted Tom’s list of 7 steps below in their entirety. I find them helpful, except for #1 (addressed above in #1).</p><p>I would add:</p><ul><li>Talk to some technical writers.</li><li>Better, talk to some technical writers in your region.</li><li>Best: talk to some technical writers in the area you want to work in (e.g., software or pharmaceuticals or manufacturing).</li></ul><p>How?</p><p>Lurk on the technical writing forums (see above for Reddit/Write the Docs). Message them directly. Open with a compliment (I’ve enjoyed your posts”) and be courteous. Ninety-nine percent will respond positively.</p><p>Tom’s Seven Steps to get a job as a technical writer:</p><blockquote>1. Build up your knowledge of tools and languages. For example, learn CSS, HTML, and XML. Also learn a help authoring tool, a graphics tool, a video recording tool, and a page layout tool.</blockquote><blockquote>2. Create a portfolio of sample technical writing deliverables. For example, create an online help, a how-to guide, a quick start guide, and a video tutorial.</blockquote><blockquote>3. If necessary, move to a city that has a lot of IT opportunities. Some popular cities are Seattle, San Jose, Austin, Boston, New York City, Denver, San Antonio, Chicago, Atlanta, Baltimore, Philadelphia, Minneapolis, Las Vegas, and many more. If you search on indeed.com for technical writer jobs, you’ll see a breakdown of available jobs by city. Also, if you look at <a href="https://en.wikipedia.org/wiki/Society_for_Technical_Communication#History">previous cities the STC Summit has been held in</a>, it usually indicates a high number of technical writers in the area. Basically any tech hub will have a lot of tech writing opportunities.</blockquote><blockquote>4. Identify your strengths and build additional specializations. These specializations might include usability, video tutorials, information architecture, marketing, e-learning, content strategy, project management, or another hybrid skill.</blockquote><blockquote>5. Start a blog to record insights and experiences about the field of tech comm. A blog will provide evidence of your knowledge, show your enthusiasm for the field, and let employers get a feel for your writing style, intelligence, and engagement.</blockquote><blockquote>6. Research the companies you want to work for, and identify a good fit for your skills. After you research the companies, create a custom cover letter that presents a case for why you would make such a good fit for the company. Although custom cover letters take time to create, they can be a powerful example of your writing skills. Taking the time to write a custom cover letter will certainly get the attention of a prospective employer.</blockquote><blockquote>7. Apply for the jobs. There are a lot of job sites (Monster, Dice, Yahoo, and more). I like Indeed.com because it consolidates job listings from multiple sites.</blockquote><h3><em>Originally published at </em><a href="https://courses.becometechnicalwriter.com/blog/revisiting-tom-johnson-s-10-most-faqs-about-technical-writing"><em>https://courses.becometechnicalwriter.com</em></a><em>.</em></h3><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=2c17de86f05a" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[The Insider’s Guide to Becoming a (Contract) Technical Writer]]></title>
            <link>https://mistertechnicalwriter.medium.com/the-insiders-guide-to-becoming-a-contract-technical-writerction-65d2b5b7e216?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/65d2b5b7e216</guid>
            <category><![CDATA[technical-writing-article]]></category>
            <category><![CDATA[technical-writing-course]]></category>
            <category><![CDATA[technical-writing]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Mon, 26 Apr 2021 01:59:31 GMT</pubDate>
            <atom:updated>2021-04-26T17:02:26.207Z</atom:updated>
            <content:encoded><![CDATA[<p>Not all technical writers understand contracting. Some have always worked as employees. They’ve never had to review a contract or even understand what goes into one. Even if they’ve hired contractors, they’ve encountered only a slice of the contracting lifecycle.</p><p>The following is based on my 20 years as a technical writing contractor in the New York City region. For this reason, this article is US-centric. However, I suspect practices are similar in Canada.</p><h3>Remote during covid</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*IfgzwC8SAJWVCexg.jpg" /></figure><p>COVID has boosted remote opportunities. More companies are hiring more contractors from remote locations. Now is a good time to grab a new contract as a technical writer!</p><h3>Which locations are best?</h3><p>It’s no secret that big cities tend to pay better but this is especially true in contracting.</p><p>The same job in New York City might pay 20% less in Central New Jersey and 30% less in Northeast Pennsylvania.</p><p>So, if you want to earn the most, consider moving to (or close to) a big city.</p><h3>Your resume as a contract technical writer</h3><p>“Technical Writer” should be your title or objective — the largest font on your resume. It’s highly unlikely your resume will be noticed if it doesn’t carry this title.</p><h3>Make it good!</h3><p>We’re writers. Our resumes should be highly polished (as we used to say about our boots in the army). If I see typos on resumes, they’re tossed. It’s that simple. The same for poor phrasing.</p><p>My advice:</p><ul><li>Raid your sofa. Check under your bed and dresser. Find that money someplace and hire a professional. A good resume writer will ask you clarifying questions that will extract more from your experience than you thought possible.</li></ul><p>If you really can’t afford a pro, then:</p><ul><li>Print it out and read it aloud to yourself. Share it with a few close friends and ask for their honest feedback. What impression do you create?</li><li>Send it to staffing agencies and ask them for their opinion. They employ people who are constantly updating resumes.</li></ul><h3>Your Portfolio as a contract technical writer</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/200/0*XBWz7d-hVe1L4E-Q.jpg" /></figure><p>Back in the day, my portfolio was a black binder. I could always email a few samples to win an interview. Then during the interview, I’d pull out my massive black binder and ask them if they wanted to review my work.</p><p>Indeed, they did. That binder got heads nodding and often won me contracts.</p><p>Today, an online portfolio is essential for contract technical writers. On a basic level, it tends to reinforce the fact that you are who you say you are. You can also send links by email to your portfolio pieces.</p><p>Note:</p><p>Most work as a technical writer is covered by an N.D.A. (non-disclosure agreement). You’re not supposed to share, and you shouldn’t. However, you can “anonymize” content by removing any identifying information from a document. Alternatively, some polished portfolios contain pictures of key pages that are scannable but not readable. If you have the design skills to do this, I’d suggest you do.</p><h4>Working with job boards</h4><p>Numbers Game? You’ve heard it called a numbers game. It’s true.</p><p>By creating a system and sticking to it regularly, you can depersonalize the experience, and not hurt as much when you’re rejected for a role.</p><h3>Passive (search agents) and active searching</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*AO5eoDX9gblbmcmP.jpg" /></figure><p>Job board search agents notify you when a job is posted. Agents can be focused on your location or specific niche (“Denver Technical Writer” or “Software Technical Writer”).</p><h4>Active searches</h4><p>Log in on a regular basis and search actively as well; set aside time for a focused and proactive search for interesting roles. If in the process, you find a new keyword, create a new agent. (You can also remove an agent if it’s not producing results.)</p><p>In the US, your resume should be posted on boards like</p><ul><li>Indeed.com</li><li>ziprecruiter.com</li><li>dice.com</li></ul><p>Other boards:</p><ul><li>Linkedin.com</li><li>Writethedocs.org (their Slack board; channel: #<strong>Job-Posts-Only</strong>).</li></ul><h3>Upwork</h3><p>While you’re waiting for a contract, you can find work on Upwork.com</p><p>Before you yell “Heck no!” because of what you’ve heard, maybe you can take a closer look.</p><p>There are good contracts on Upwork but before you respond to job postings, sign up for Danny’s email list at <a href="https://freelancetowin.com./">https://freelancetowin.com.</a> Danny is an “Upwork Jedi” and can teach you how to succeed where so many fail.</p><h3>About staffing agencies</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*-_lsPHjXXZ_JGXRj.jpg" /></figure><p>Staffing agencies face a cutthroat business environment. The emergence of international outsourcing over the past 20 years has made them direct competitors with domestic firms. They represent not only US Citizens and Visa holders but also Visa eligible applicants at highly competitive rates. Some of these are billion-dollar firms with huge operating budgets. It’s a “dog-eat-dog” industry.</p><p>Further, the business models of staffing agencies must assume that <em>most </em>applicants they carefully select for their end clients do not get hired. They can spend hours finding, interviewing, and vetting references only to face repeated failures to win contracts.</p><p>Some companies do not require staffing agencies to be on a select list of “approved vendors.” This means a dozen staffing firms or more could be presenting resumes for a specific position. Therefore, you’re likely to see multiple emails about the same position. Confusing, right?</p><p>Some “boutique” agencies with fancy offices and huge marketing budgets (i.e., massive overheads) enjoy 40% margins on the hourly wages of their contractors. In other words, they bill the end client $100 and pay you $60</p><p>Most margins are much less. However, don’t worry about what they’re taking home. Worry about what you’re taking home.</p><h3>They look after themselves first</h3><p>I think a lot of people new to staffing agencies really believe that they care about your welfare.</p><p>Companies are made up of people. A company is not a person.</p><p>It’s important to understand that no matter how nice individuals can seem, most staffing agencies don’t give a hoot about <em>your </em>well-being. They’re just looking for someone to make <em>them</em> stand out. They’re looking to make a profit.</p><p>I have met a few exceptions but they’re invariably senior people in smaller firms who enjoy a lot of latitude over business decisions.</p><h3>Emails from staffing agencies</h3><p>Most initial interactions with staffing agencies happen via email. If you do happen to get a phone call, it’s usually immediately after they’ve sent you a JD (job description). If they haven’t, ask them nicely “Could you please send me the job description?”</p><h4>Reading subject lines</h4><p>Beware flowery adjectives!</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/584/0*-hp8VudLyczSa6SM.jpg" /></figure><p>Look at the adjectives shaded in red above. <strong>Urgent; Exciting; Immediate</strong> etc… usually mean the recruiter is trying to get you to open their email, nothing more. (Other common openings: <strong>Interviewing Now; Needed ASAP.</strong>)</p><p>Think about it: What’s a non-immediate job opportunity? I haven’t seen many of them.</p><p>The descriptions in green tend to be free of hype.</p><p>Lesson: Beware the first word or two in a subject line.</p><h4>The email body</h4><p>Look for terms like “Rate Confirmation” or “Right to Represent.”</p><p>Larger end clients want the last four digits of your Social Security Number or your month/day of birth so they can track you in their system. This helps them avoid duplicate submissions from multiple firms (which means they must reject a candidate).</p><h4>How to respond?</h4><p>Sometimes they’ll mention the hourly range. Sometimes they say, “it’s flexible” or “it’s market rate,” but mostly they’ll display a number or a range.</p><p>If they don’t provide a rate clue on their first email, I’ll send a nice reply like:</p><p>Hi Tom,</p><p>Thanks! This looks like a great fit. Before we discuss the specifics further, would you by any chance have a ballpark wage?</p><h4>Magic Terms:</h4><p>Look out for the following magic terms:</p><p>* EXCLUSIVE: This means they’re the only firm presenting candidates. Much less competition for them and you. You may be one of three or four candidates.</p><p>* BACKFILL: Someone is leaving a contract prematurely due to illness or childbirth and the position IS needed urgently. These are typically fast-moving positions. You won’t be waiting days by the phone to hear if you’ve been hired or not.</p><h4>Say yes when you mean maybe</h4><figure><img alt="" src="https://cdn-images-1.medium.com/max/200/0*v4W4OFgiThL-F1C7.jpg" /></figure><p>Anytime a requirement (“req” in their lingo) is released to multiple agencies, there’s a mad scramble to “lock-in” commitments from applicants to avoid poaching or duplicate submissions.</p><p>Must you commit to a rate if you’ve agreed to it in your email response? If you don’t agree to their proposed rate upfront (or they to your higher rate), your resume is not presented. It’s that simple.</p><p>I’ve found that most contracts have some flexibility in the rate. If it’s close to my desired rate, I’ll say yes. If it’s not close, I’ll tell them what my rate is.</p><p>Then, I’ll wait till after the interview to ask for more.</p><p>Of course, no staffing company wants to hear that.</p><p>“You agreed to the rate, didn’t you?” they’ll say.</p><p>“Yes, but that was before I knew the scope. The scope in the interview was greater than the scope in the job description sent to me.”</p><p>How could they argue with that?</p><p>I’ve found most agencies will pay you more rather than lose the contract to a competitor. Will you be invited to the Christmas party at year’s end? Maybe not.</p><p>But you’ll have the additional money to throw your own party.</p><p>If you like the job and do well, you could be there for a long time and that money will add up. You always want to get the best rate possible.</p><p>One dollar more per hour over two years becomes a lot of money!</p><h4>Low-ball offers</h4><p>If you see a very low rate, ask nicely if they have any flexibility at all on the rate. Some will. Some won’t.</p><p>You can say “Good luck with it” and move on.</p><p>I’ve seen hourly rates that are not much higher than the minimum wage. I don’t know how they do it. And I don’t care.</p><p>I‘ve never accepted low-ball wages as a contract technical writer.</p><p>Don’t do it, even if it’s your first position. You’ll resent the job and yourself for underselling yourself.</p><p>Quick quiz:</p><p>How does a lost dollar easily become thousands of dollars lost?</p><p>Answer:</p><p>When you accept a lower rate than you could otherwise get, and then remain on the contract for two years. Do the numbers. A dollar can cost you dearly over the length of the contract.</p><p>Also, staffing agencies do not give you raises unless they think you’re ready to jump to another opportunity. Raises in contracting are extremely rare. Staffing agencies have their revenue forecasts over the next umpteen months, and they’re loathe to adjust them downward for one contactor.</p><h3>No duplicate submissions</h3><p>Do not agree to be represented by more than one recruiter for the same job.</p><p>The client will reject you even if you’re the best fit because they won’t want to deal with two competing agencies fighting over you.</p><h3>Asking the best questions</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*Y7KnEIX6pdbPpCCV.jpg" /></figure><p>Some of the best questions to ask staffing agencies:</p><p>* Is this an exclusive contract for your firm?</p><p>* Have you worked with the end client before?</p><p>* Can you tell me about the end client?</p><p>* Do you have staff on board already? (If so, are they attached to this project?)</p><p>* What’s the hiring manager like?</p><p>* What are the other candidates (my competitors) like?</p><h3>About job descriptions</h3><p>Know the joke about the Christmas fruit cake?</p><p>“The worst Christmas gift is fruitcake,” cracked the comedian Johnny Carson. “There is only one fruitcake in the entire world, and people keep sending it to each other, year after year.”</p><p>That applies to many job descriptions as well. It seems like companies have one template, and they just keep reusing it year after year after year.</p><p>If what you’re reading sounds like jargony gobbledygook, that’s because it IS!</p><p>Ignore the gook and read the requirements. They’re typically bullets.</p><p>If you fit 40% of the bullets, apply. Too many people wait to match 80% of the requirements and they miss out.</p><p>Job descriptions are often like a description of our ideal partners. They don’t exist. Neither does the candidate who’s going to fit an excessively detailed job description.</p><h3>About contracts</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*RjML4gO5zzqh_Zvq.jpg" /></figure><p>Contracts include the hourly rate, payment terms, confidentiality protections, and a non-disclosure agreement between you and the staffing agency. The end client has nothing to do with your contract.</p><p>Less than two years after starting as a Technical Writer, I formed an S Corp. I invested in a lawyer who gave me outstanding advice about contracts.</p><p>He was expensive, so I learned how to do it. I also learned that I had every right to disagree with a term and cross it out or amend it before signing.</p><p>My advice:</p><p>* Pay for a lawyer when starting out.</p><p>* Don’t hesitate to change the contract. At this point, everyone wants you on board.</p><p>* Most don’t request a change because most don’t read contracts. Then they find out they’re required to give four week’s written notice to terminate the contract but they can be fired at any time!</p><p>* PS: I insisted on equal terms regarding termination. Many contracts today state: “either party may terminate this at any time.”</p><h3>Tax status</h3><p>Companies use staffing agencies to avoid the burdens of issues like taxes, benefits, and legal matters (like disciplinary actions). The last thing they want is for you to be confused for an employee or anything more than a temporary worker.</p><p>For this reason, a W2 tax status, where you are an “employee” of the staffing agency, is prevalent today.</p><p>A few years back you’d often be offered a choice. You could work “1099” as an independent contractor, and the staffing agency would take their cut and give you the rest. You’d get a higher hourly rate, but you’d be responsible for taxes and benefits.</p><h3>Don’t worry about the following!</h3><h3>Unresponsive recruiters</h3><p>Even after they genuflect before you, throw roses at your feet and swear on their mother’s life not to ignore you, they go ahead and forget to update you on your status, especially if you were passed over for the job.</p><p>Try not to personalize this. Play the numbers. They do!</p><h3>The margins your agency makes on your wages</h3><p>I’ll never forget the department manager calling me into her office just before Christmas one year. This was a global media company in a tower overlooking Central Park.</p><p>“Bobby, these invoices seem a little off. Take a look at this.”</p><p>Without hesitation, I looked at her finger on the display. I couldn’t believe my eyes. There was the hourly rate they were billed. It was a LOT more than I received.</p><p>I became rattled about it and struggled to regain my focus. I did the math. It was a 40% margin! The steam poured out of my ears.</p><p>Then on the subway ride home, I had a flash of insight. Yes, it was a huge margin; it had to be the biggest in over 10 years. However, my hourly was the largest, too.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/300/0*U89-Td-hYpC-0s09.jpg" /></figure><p>I worked for a “preferred vendor” with a fancy office and reps who looked like models and delivered bagel breakfasts every other Friday. I learned that this was how this global media giant and agency wanted to do things, and it wasn’t my business. I was a beneficiary too.</p><h3>Benefits?</h3><p>Many staffing agencies offer benefits. You can ask them before your interview. Especially in the United States, their health insurance might be a lot more affordable and higher quality than what you can get as an individual. Ask!</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=65d2b5b7e216" width="1" height="1" alt="">]]></content:encoded>
        </item>
        <item>
            <title><![CDATA[11 Rules for New Technical Writers]]></title>
            <link>https://medium.com/swlh/11-rules-for-new-technical-writers-d1eb6c45e396?source=rss-48e06c18c2a4------2</link>
            <guid isPermaLink="false">https://medium.com/p/d1eb6c45e396</guid>
            <category><![CDATA[rules-for-writing]]></category>
            <category><![CDATA[rules-of-life]]></category>
            <category><![CDATA[technical-writer]]></category>
            <dc:creator><![CDATA[Mister Technical Writer]]></dc:creator>
            <pubDate>Sun, 14 Mar 2021 16:52:47 GMT</pubDate>
            <atom:updated>2021-04-18T01:18:17.772Z</atom:updated>
            <content:encoded><![CDATA[<p>Are you new to technical writing and want to advance your career? This list might save you some unnecessary frustration and aggravation.</p><p>Find the tone patronizing or condescending?</p><p>It shouldn’t be, especially if you understand one thing. These 11 items reflect issues I personally experienced when I began my career over 20 years ago. I suspect they’re relevant to nearly all technical writing roles, no matter the industry.</p><h3>1) Be genuinely helpful</h3><p>Strive to be friendly and helpful (to those above and below you). This doesn’t mean you relax your boundaries and become a doormat.</p><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*vCiLiH4Hv9nEl3kV-DorYA.jpeg" /></figure><blockquote>Tech writing is a <strong>support role</strong>. <em>So be supportive!</em></blockquote><h3>2) Just listen (at least for the first month on the job)</h3><p>The only way you’ll get to know and understand your team and colleagues and what’s expected of you is by listening. <em>If you’re a skilled listener, congratulations. You’re a rare breed.</em></p><p>Some things you can observe when you listen:</p><p>What is their preferred method of communication? When? When are they not available? When are they most available? What is their current workload like? What will it be next month? (And on and on…)</p><p>I am NOT a world-class listener, because I love to TALK TALK TALK! If you’re anything like me, just listen, especially when starting a new job!</p><h3>3) Grab data about your work</h3><p>These days, management is obsessed with data.</p><p>So whenever you can gather data, even if it’s positive verbal feedback, save it. When the economy hits the rocks, the stars in marketing and sales aren’t let go. Support folks are. Unless they can prove their value.</p><h3>4) Fight “Rodney Dangerfield Syndrome”</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*Y20htBV2-qBPhXooksap9A.jpeg" /><figcaption>(Not Rodney Dangerfield)</figcaption></figure><p><strong>Note</strong>: You may find Rodney’s humor offensive. If you <a href="https://www.youtube.com/watch?v=b0toL3C0R14">listen to this clip,</a> you’ll find his famous tagline at 58 seconds.</p><p>The feeling that “I don’t get no respect” is common to the profession. If you browse the popular forums (see next item), you’ll find this popping up again and again. Sometimes, we’ll have to find other ways to get our egos stroked.</p><p>If our expectations are too high, we’ll be sharing the dressing room with Rodney.</p><h3>5) Seek advice from multiple tech writers</h3><p><strong>Tip:</strong> If you haven’t already, sign up for <a href="https://www.reddit.com/r/technicalwriting/">Reddit’s Technical Writing</a> forum and <a href="https://www.writethedocs.org/slack/">Write the Docs</a> Slack channel.</p><p>There are experienced tech writers who are kind and generous and thoughtful and will help you out. For free. You just have to ask.</p><p>There are veteran tech writers who are mean, bitter, and love trolling new technical writers.</p><p>How to know which feedback is valid? Engage multiple writers.</p><h3>6) Be a genuine team player</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*XFTTX8xVGkKJC8BPSLbIsg.jpeg" /></figure><p>You’re part of a team, even if it doesn’t say so on the org chart.</p><p>Maybe you work with development or QA or design.</p><p>The one way to ensure their support is by supporting them.</p><h3>7) Become a quality communications hub</h3><p>Tech writers tend to be introverted. Some believe that documents are their sole focus. So they huddle in a corner writing away like some ancient monk and shun other communications.</p><blockquote>Don’t be a monk.</blockquote><p>Make sure that you’re responsive when you speak or use email or chat — and your quality is evident no matter the medium. It will improve your value to your organization.</p><h3>8) Exercise verbal discretion: Don’t generalize or talk just to talk</h3><p>Ever notice that really smart people don’t generalize or say stupid things?</p><blockquote>Tech writing is about specifics, not generalities.</blockquote><p>You’ll typically be working with people who know the subject matter better than you. So don’t make them think you’re incapable of learning and documenting their material by talking just to talk.</p><h3>9) Learn as much as possible</h3><p>SMEs (Subject-Matter Experts) hate to handhold or spoonfeed their knowledge to technical writers. A sure way to be viewed as an overpaid administrative assistant is to not make any effort to learn even the basics.</p><p>Show initiative by learning what you can on your own. Ask the experts for resources so you can learn more.</p><p>At the minimum, try to master the concepts and language used to convey them. After all, the concepts and language are <em>your</em> domain.</p><h3>10) Underpromise and overdeliver</h3><figure><img alt="" src="https://cdn-images-1.medium.com/max/1024/1*VyVEdcJFgt9h1fPMAzhKaQ.jpeg" /></figure><p>Make deadlines. Early, if you can. Don’t manipulate people with petty power games like</p><blockquote>“Oh, if they value me, they’ll be fine with my being late.”</blockquote><p>Don’t do it. You’ll erode trust in your performance. And your character.</p><h3>11) Accept that technical writing will never make you rich or famous</h3><p>Tech writing has been a stable and well-paying career for me and many others. But have no illusions. If you’re at the “tippy-top” in the best region, you’re still not going to earn much more than 6 figures.</p><p>You’ll never see your name in lights or your face on a box of cereal. You may not even see your name on a document (this isn’t journalism). But you will know that you’ve genuinely helped people by making complex matters more understandable. And that’s not nothing!</p><img src="https://medium.com/_/stat?event=post.clientViewed&referrerSource=full_rss&postId=d1eb6c45e396" width="1" height="1" alt=""><hr><p><a href="https://medium.com/swlh/11-rules-for-new-technical-writers-d1eb6c45e396">11 Rules for New Technical Writers</a> was originally published in <a href="https://medium.com/swlh">The Startup</a> on Medium, where people are continuing the conversation by highlighting and responding to this story.</p>]]></content:encoded>
        </item>
    </channel>
</rss>