What Value Technical Writers Bring to Business?

技术作家能给商业带来什么价值?

2020-07-08 15:40 clickhelp

本文共809个字,阅读需9分钟

阅读模式 切换至中文

Technical documentation is viewed as something handy and nobody would ever doubt that it is necessary to have one. On the other hand, technical writers are faced with the reality of people underestimating what they are doing. We’ve painted a dreadful picture of a post-apocalyptic world where tech writers don’t exist anymore. But, sometimes, it is important to go through the most basic and down-to-earth things like, if you save on tech writing you will potentially lose a lot of clients and money. I am going to point out three major things that technical writers help piece together for a company: product adoption, case deflection, and overall user satisfaction with a product. Let’s start! Better Product Adoption Product adoption oftentimes starts with a demo and can be extremely helpful. The vendor always says things like - you can contact us anytime if you have questions and we'll help you with that. But when a user is left alone with a product, they, most likely, will have a lot of questions, even the most basic ones, that they wouldn’t feel too comfortable to contact the vendor about. Nobody wants to look bad and, also, it can take too much time trying to settle such things via email or by setting up calls. Plus, more questions tend to come up very quickly when you are starting to work with a new tool. It is truly amazing if your company has overarching learning opportunities, however, even this will not suffice - you can’t squeeze all the details, examples, and instructions into a learning course, besides, some things are too specific to be even mentioned there. Learning courses are created to explain the most used features. With all that said, technical documentation is a perfect resource for product adoption: Online documentation is available at any given moment - a reader just needs an internet connection and a browser. Documentation can include not just text but also things like videos, all kinds of images, code examples, etc. Technical documentation can be as thorough as you want - you can even make a separate pro version of your user manual using single-sourcing techniques if you don’t want it to be overly complex for the general audience. Users can find exactly what they need with the help of navigation mechanisms like an Index, a TOC, filtered search, See Also elements, etc. See how this all can work out great for an immersive adoption experience? There’s a high chance that without this opportunity to learn and understand the product, a client will just drop it. Case Deflection for Technical Support When a user gets a hold of the tool, they will start asking other kinds of questions. Not just like ‘what does this button do?’(however, this one is always a possibility :) ), but the kind that will go to the support queue. Sometimes, users find bugs, but more often than not, they just aren’t aware of the tool’s full potential. A lot of such questions can be avoided if you have a thorough and well-written technical guide, an online user manual, or at least an FAQ section. It is next to impossible to count the exact amount of money we are saving by having good technical documentation versus hiring more and more support engineers, but the profit is clearly there. Good user documentation helps companies make their technical support model scalable. Also, don’t forget that user manuals are used internally to teach new Technical Support engineers about the product, too. Which means, again, saving time and money that would otherwise go to cover the extra onboarding efforts. Higher User Satisfaction User manuals provide guidance for your clients throughout their journey with your product. This means that techcomm is a crucial means of increasing user satisfaction. If you fail to deliver the technical documentation your target audience requires - this will leave a lot of customers disappointed. Quality documentation helps users use a tool to its full potential, teach how to overcome pitfalls, and provide a clear vision of the product. Some companies prefer to leave this to support and marketing, but such an approach is short-sighted. Neither will be able to dedicate enough time to every single user who needs a deep-dive into the product while an online documentation portal will. Conclusion So, what is the price of saving on good tech documentation? The tall is really high. And, it is not just money. It is more about whether your clients will feel that your company cares about them. There isn’t even a choice - to build fruitful long-lasting relationships with your users, providing them with high-quality techcomm content is what every company should do. Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
人们认为技术文档是行之有效的存在,没有人会怀疑它存在的必要性。但是,技术作家面临着被低估的现实。我们描绘了一幅新冠疫情结束后的世界的图景,在那里技术作家不复存在,这糟糕透了。 但是有时候,检查一些最基本、最实际的事情是很重要的,比如,如果你在技术写作上省了钱,你可能会失去很多客户和资金。下面我将指出技术作家帮助公司整合的三个主要方面:产品采用,案例分析和用户对产品的总体满意度。开始吧! 优化产品采用 产品的采用通常从样本开始,这一点大有裨益。供应商总是这样说:如果你有问题,可以随时联系我们,我们会帮你解决的。但是当用户独自面对产品时,他们很可能会有很多问题,即使是最基本的问题,他们也不太愿意与供应商联系。没有人想以糟糕的一面示人,而且,通过电子邮件或打电话来解决这些问题可能会花费太多时间。另外,当你开始使用新的产品,很快会出现更多的问题。 如果你的公司提供包含各个方面的学习机会,那真是太棒了,然而,即使这样也不够,因为你不可能把所有的细节、例子和指示都塞进一门学习课程中。此外,有些东西太具体了,根本不可能在课程中提及。创建学习课程是为了解释最常用的功能。综上所述,技术文档是产品采用的完美资源: 在线文档任何时候都触手可及,读者只需要互联网链接和浏览器即可。 文档不仅可以包含文本,还可以有视频、各种图像、代码示例等。 技术文档可以完全按照你的要求创建,如果你不希望统一的用户手册过于复杂,那么你可以使用单源技术制作单独的用户手册专业版本。 用户可以通过导航机制,如索引、目录(TOC)、过滤搜索、参见元素等准确地找到他们需要的内容。 看看这些是如何为沉浸式产品采用的体验提供帮助的?如果没有这个机会来学习和理解产品,客户很可能会直接放弃。 用于技术支持的案例分析 当用户拿到产品时,他们会开始问其他类型的问题。不只是像“这个按钮有什么用?”这种问题(不过,这个问题很有可能会被问),而是会问及产品支持相关的问题。有时,用户发现了错误,但通常,他们只是没有意识到该产品的全部潜力。如果你提供一份既详尽质量又高的技术指南,在线用户手册,或者至少常见问题解答,那么很多类似的问题就可以避免了。 要计算出优质的技术文档和越来越多的支持工程师帮助节省的确切金额,是几乎无法做到的,但是利润十分明显。优质的用户文档有助于公司扩展其技术支持模型。另外,别忘了,用户手册也用于向新的技术支持工程师提供有关产品的内部指导。这意味着又一次节省了时间和金钱,否则将用于支付额外的入职管理。 提高用户满意度 用户手册为你的客户在使用产品的整个过程中提供指导。这意味着技术文档是提高用户满意度的一个至关重要的途径。如果你不能提供目标用户需要的技术文档的话,会令很多客户失望。高质量的文档能帮助用户充分利用产品的潜力,指导用户如何克服陷阱,并提供产品的清晰愿景。 有些公司宁愿把技术文档抛给支持和营销部门,但这样做不利于长远发展。这两个部门都不能为每一个需要深入研究产品的用户投入足够的时间,而在线文档可以。 结论 那么,节约优质技术文档的成本,会付出什么代价?代价真得会很大。而且,不仅仅是金钱。更重要的是客户会不会觉得你们公司关心他们。为了与用户建立富有成效的长久关系,为他们提供高质量的技术文档是每个公司都应该做的,这一点无法选择。 祝你的技术写作顺利! 单击帮助小组 跨平台和设备编写,主持和提交文档

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

阅读原文