Succeeding as a Technical Writer

一个技术作家的成功之路

2021-01-20 18:00 clickhelp

本文共766个字,阅读需8分钟

阅读模式 切换至中文

“The tendency of remote working in 2020 is blended into 2021”. And, the field of technical communication continues to grow since this sphere is one of those that are not tied to a certain workplace. Worldwide demand for simplified technical English also keeps growing because developing countries (i.e., India or China) export great amounts of products that need technical documentation. And, they acknowledge the need to improve their technical documentation. Companies that hire technical writers want to ensure that content is consistent and of top quality. But technical writing isn’t confined to these frames. Technical writers work in software, consulting, government, broadcasting, transportation, telecommunications, healthcare, publishing, etc. US Bureau of Labor Statistics projects the “up to 10 percent growth in demand of technical writers” due to constant increase in scientific and technical products. In this connection, more and more universities offer Courses for Tech Writing, and a growing number of people enter the profession of a tech writer. See for yourself Best Courses/Books/Resources for Technical Writers. That’s why a technical writer must always improve relevant skills to outstand among other applicants. Advice to Level Up Your Skills and Strengths as a Technical Writer First of all, you should stay focused: choose the technical area you have a specific skill set in. It can range from medicine to space, from games to agriculture, and many more. Deepen your knowledge in that sphere with any means accessible. In fact, with every new document you create, you become more well-grounded on that subject, and your value increases. No technical writer can do without a standard approach to writing. Using a style guide is a must and even a newcomer knows that. But no harm is done in repeating the truism. So, the style guide is a set of standards for writing and designing content. The style guide for technical writing defines the style that should be used in technical communication. It helps you write documentation more clearly and keep a consistent tone of voice and style. You can create your personal style guide, but it is more time- and effort-saving to use the existing ones and customize them for your needs. Many of them are freely available: ASD-STE100 Standard, or the Simplified Technical English style guide Microsoft Manual of Style Oxford Manual of Style Handbook of Technical Writing Apple Style Guide The IBM Style Guide online or the PDF Google Style Guide, etc. AP Stylebook Tech writers must understand Content Management Systems (CMS) and digital tools such as: WordPress Joomla Drupal Magento Squarespace etc. A huge variety of CMSs exist nowadays, but not many of them are specialized exactly for technical writers. ClickHelp is one of such a whiz. It’s a cloud-based online documentation tool that provides a flexible, user-friendly solution when creating docs. Keep learning. Consultation with specialists is crucial. Such people should be pros on the topic you’re working on. SMEs (Subject-Matter Experts) will deliver additional or analogous information that can make the user guide more complete to the end reader. Don’t miss an opportunity to maintain contact throughout your work as professionals can add value at different stages, especially during a review, and broaden your knowledge of the matter as well. Improve your communication skills. Some projects demand more than one tech writer. This means you will have to successfully cooperate with others, so that deadlines are achieved and made in good order. We cannot help you improve your personal qualities, but ClickHelp can help your teamwork organize the process. Aim for readers. Technical writers are translators in some sense. They translate complex texts into a plain language understood by average users. To do this successfully, tech writers must know their audience, differentiate their readers based on their understanding, and target people for products correspondingly. The document may consist of the same information, but the data submission differs greatly for different users. That’s when single-sourcing comes to help. Conclusion To become prosperous as a technical writer, you should always remember to level up the skills that we mentioned. The important thing is to understand that it’s not a sprint; it’s a marathon. Overall, prospects for growth include working on more complex projects. “According to a small inquiry we made, it takes three years on average to become a Senior Technical Writer.” Just keep improving and learning and use correct tools, like ClickHelp. That’s the key to your success as an expert technical writer. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
2020年远程工作的趋势正逐步进入2021年。 由于技术通信领域与某个特定的工作场所无关,因此导致其持续的增长。随着发展中国家(如印度、中国)出口大量需要技术文档的产品,全球对简化技术英语的需求也在持续增长。并且他们承认他们的技术文档需要进一步加强。雇佣技术作家的公司希望确保内容的一致性和顶级质量。但技术写作并不局限于这些框架。技术作家在软件,咨询,政府,广播,交通,电信,医疗,出版等多领域工作。 美国劳工统计局称 对技术作家的需求率将增长到10% 由于科技产品的不断发展。 在这方面,越来越多的大学开设科技写作课程随之更多人人进入科技作家的行业。自行查看适合技术作家的最佳课程/书籍/资源。这就是一个技术作家必须不断提高相关技能,才能在其他求职者中脱颖而出的原因。 提升技术作家的技能和实力的建议 首先,你应该保持专注:选择你拥有特殊技能的技术领域。其范围可以从医药到太空,从游戏到农业,等等。同时要通过某些方法加深你在此领域的知识或对其的了解。事实上,您创建每一个新文档后,您在该主题的基础就会变得更加牢固,您的个人价值也会随之增加。 任何一个技术作家都有一种标准的写作方法。一个新手都知道的一点是使用风格指南是必要的。但重复这一自明之理并没有什么坏处。因此,风格指南是一套写作和设计内容的标准。技术写作风格指南定义了在技术交流中应该出现的风格。它可以帮助您编写更加细致的文档,且整个文档保持一致的语调和风格。您也可以创建您个人的风格指南,但使用现有的风格指南并根据您的需要对其进行自定义修改会更省时省力。其中许多是免费提供的: 简易技术英语标准,或简化技术英语风格指南 微软风格手册 牛津风格手册 技术写作手册 苹果风格指南 联机风格指南或可携带文档格式 谷歌风格指南等。 美联社写作风格指南 技术作者必须了解内容管理系统(CMS)和数字化工具,例如: 博客系统 逐浪 文档管理 网页设计 建站服务 等。 现今存在着各种各样的CMS,但并没有多少是专门为技术作者提供的。ClickHelp就是一个天才。它是一个基于Cloud的在线文档工具,在创建文档时会提供一个灵活友好的解决方案。 持续学习。咨询专家是至关重要的。这样的人应该是你正在研究主题方面的专家。SMEs(专题专家)将向最终读者提供额外的或类似的信息,使用户指南更加完整。另外不要错过你工作中任何一个保持联系的机会,因为这些专家将会在不同的阶段增加价值,尤其是在审查期间,也可以扩大你对这件事的了解。 提高你的沟通技巧。有些项目需要的科技作家不止一个。这意味着你必须能够成功地与他人合作,这样你就能在最后期限内井井有条的完成任务。我们无法帮助您提高个人素质,但ClickHelp可以帮助您的团队合作组织过程。 以读者为目标。从某种意义上说,科技作家就是译者。他们把复杂的文本翻译成普通用户能理解的简单语言。要完美地做到这一点,科技作家必须了解此文本的受众人群,根据他们的理解区分他们的读者,并相应地针对产品的目标人群。文档可能由相同的信息组成,但数据提交对于不同的用户差异很大。这就需要单源的帮助。 结论 要成为一个成功的技术作家,你要一直记得提升以上提到的技能。更重要的是,要明白这并不是一项短跑运动,而是一场马拉松。总之,增长的前景包括从事更多复杂的项目。 根据我们做的一个小小的调查,一个人要成为一名高级技术作家平均需要三年的时间。 不断改进和学习,使用正确的工具,如ClickHelp,是你作为一个专业技术作家成功的关键。 祝你技术写作之旅顺利! 单击帮助团队 翻译技术速递

以上中文文本为机器翻译,存在不同程度偏差和错误,请理解并参考英文原文阅读。

阅读原文