8 Misconceptions About Technical Writing

8个关于技术写作的误解

2020-01-28 21:30 clickhelp

本文共652个字,阅读需7分钟

阅读模式 切换至中文

Misconceptions are as annoying as hell. Especially when they are connected with something you love and do for a living. Let's take a look at common misconceptions about techcomm and bust them! Looks Don't Matter As much as we hope this to be true for human interaction, it is certainly not the case with user manuals. For most people (especially the non-tech types) even thinking about reading walls of technical text is stressful. But when external factors like bad design appear, be sure they will not put in the effort and rather demand a call with the support team. If making user manuals beautiful might not be the top priority for your team, making them readable should be! English Only Many companies fall into this English-only trap especially the ones the primary markets of which are English speaking. Software, for example, is a huge market with predominantly English speaking users. However, that to no extent means that all their clients know the language well enough to be able to go through complex technical documentation swiftly. Rocket Science There's a common belief that to be a tech writer one requires super deep knowledge of the subject they are describing. Getting into specific areas like space or medical techcomm is not always as easy without a degree, but honestly, you can start a great career based on good tech writing skills, general subject knowledge, and the will to grow. Tech Writing is Boring This might be true for some who hate creating content. But consider this: types of technical documentation are so varied and require different approaches - no time to be bored. Plus, not many realize the true scope of what tech writers can do. They can create learning materials, whitepapers, presentations, videos. That's why we call it technical communication - often it is much more than just writing. No Need of Help Authoring Tools Help authoring tool is, in fact, what any tech writer needs. It doesn't even matter how big the project is or whether teamwork is involved at all. Tools for technical writing make every stage of the process much easier. Instead of spreading yourself thin between several tools in an attempt to somehow get a solid user manual out of this process, look at what is currently offered in the HAT market. Modern software for help authoring is so feature-rich and flexible that you won't need to use additional services to produce high-quality user manuals. Tech Writers are Introverts Not necessarily. People are talking about this sometimes like about a prerequisite for getting into this profession. Actually, there's a lot of communication inside the doc team and across different teams. Besides that, technical writers love good public events like conferences and meetups. Technical Documentation Is Not Important This misconception is especially striking when people are trying to compare tech writing against other stages of product development. Actually, technical documents are holding both internal and external processes together. Teams would not be able to collaborate properly inside a company without the docs. And how would they explain stuff to users? Still think technical documentation isn't that important? Check out our post-apocalyptic article about how 'joyous' life would be without user manuals. Creativity Is Banned Believe me, those who crave creativity will bring it with them anywhere they go. Actually, there is a place for things like metaphors, similes, analogies, and other devices in user manuals. The trend is clear - making technical texts sound more human-like. Those who want to go deeper with this whole idea of humanizing technical communication, check out this post on technical writing advocacy. Conclusion Do you have any other techcomm misconceptions that drive you insane? Share them in the comments below. Let's get rid of them :) Good luck with your technical writing! ClickHelp Team Author, host and deliver documentation across platforms and devices
误解和地狱一样令人讨厌.特别是当他们和你所爱的东西有联系的时候。让我们来看看关于 techcomm 的常见误解,并把它们击垮! 外表不重要 尽管我们希望这对于人类交互来说是正确的,但用户手册的情况当然并非如此。对于大多数人(特别是非技术类型的人)来说,甚至考虑阅读技术文本的墙壁也是很有压力的。但当外部因素如糟糕的设计出现时,请确保他们不会投入工作,而是要求与支持团队联系。如果让用户手册变得漂亮可能不是你的团队的首要任务,那么让他们读起来应该是! 仅限英语 许多公司都陷入了这种只有英语的陷阱,尤其是那些以英语为主要市场的公司。例如,软件是一个巨大的市场,主要是说英语的用户。然而,这在一定程度上并不意味着他们的所有客户都非常熟悉这种语言,能够迅速地通过复杂的文档技术。 Rocket Science 人们普遍认为,要想成为一名科技作家,就需要对他们所描述的主题有超级深入的了解。如果没有学位,进入特定的领域(如空间或医疗技术)并不总是那么容易,但老实说,你可以在良好的技术写作技能、一般的学科知识和成长的意愿的基础上开始一个伟大的职业生涯。 技术写作令人厌倦 对于那些讨厌创建内容的人来说,这可能是正确的。但考虑到这一点:文档技术的类型是如此的多样化,需要不同的方法-没有时间感到无聊。此外,没有多少人意识到科技作家能做什么的真正范围。他们可以创建学习材料,白皮书,演示文稿,视频。这就是为什么我们称它为技术交流-通常它不仅仅是写作。 无需帮助创作工具 事实上,帮助创作工具是任何科技作家所需要的。这个项目有多大,或者团队合作是否参与都无关紧要。技术写作工具使过程的每个阶段都变得容易得多。 不要把自己分散在几个工具之间,试图以某种方式从这个过程中得到一个可靠的用户手册,看看目前在 HAT 市场提供什么。现代的帮助编写软件功能丰富且灵活,您不需要使用其他服务来制作高质量的用户手册。 技术作家是内向的 不一定。人们谈论这件事有时就像是进入这个行业的先决条件。事实上, doc 团队内部和不同的团队之间有很多沟通,除此之外,技术作家喜欢像会议和聚会这样的公共活动。 技术文档不重要 当人们试图将技术写作与产品开发的其他阶段进行比较时,这种误解尤其引人注目。 实际上,技术文档同时包含了内部和外部流程。没有这些文档,团队就无法在公司内部进行适当的协作。他们将如何向用户解释这些东西? 还是认为文档技术不那么重要?看看我们的《启示录》后的文章,关于没有用户手册的“快乐”生活是如何的。 禁止创造性 相信我,那些渴望创造力的人会带着它去任何地方。实际上,在用户手册中有一个地方可以使用比喻、比喻、类比和其他设备。 这一趋势是明确的,技术文本听起来更像人。那些想要深入理解这种人性化技术交流的想法的人,看看这篇关于技术写作宣传的文章。 结论 你有没有其他的技术错误观念让你发疯?在下面的评论中分享。让我们摆脱它们吧:) 祝你的技术写作好运! 单击帮助团队 跨平台和设备创作、托管和交付文档

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

阅读原文