作者:

你还记得最近一次看某个产品的技术手册是什么时候吗?你是否认真读了?

技术手册通常会被遗忘在某个角落,直到几个月后的某一天你也许突然就需要它了。其实,看似不起眼的技术手册一点都不简单,尤其是那些多语言版本的小册子,需要大量细致的工作,所以我们应该感谢这些技术文档背后的无名作者。

对于科技公司来说,技术作者尤为重要。他们一一拆解复杂的技术问题,并用通俗易懂的语言向受众解释,然后精心制作成技术文档。对于用户来说,技术文档是他们首次使用产品时的第一个助手,并且在使用产品期间都可以作为参考资料。

要写出一本高质量的技术手册,技术作者必须是一个多面手,既要搞清楚技术细节,又要让大众能够看得明白,还得应付一些突如其来的变化。有时,各方面的压力也许会让一个技术作者抓狂,但他们专业、冷静与客观的态度使他们能够在约束中发挥创造力,并最终呈现完美的手册。

那么,一个技术作者的日常是怎样的?他们通常会遇到哪些令人抓狂又不得不去面对的问题呢?

争取时间与专家沟通

某一主题或领域的专家一般都掌握丰富的技术信息,因此对于撰写技术文档至关重要,他们可以验证内容的准确性并且帮助文章脱颖而出。但是,这些专家通常也非常忙,技术作者需要不断争取专家的宝贵时间来获取某个特定项目的信息。

而当他们最终获得这些信息时,还需要扮演 “翻译” 的角色,因为这些专家可能没有时间以普通人的视角来解释抽象的概念。

设法了解产品

有时,技术作者了解产品的渠道有限,尤其是软件、应用程序,或者仪器设备等不能 “玩” 的产品,确实会限制技术作者对产品的理解。这也就为技术作者带来了与专家沟通的更多压力,以获取准确的信息。相关材料(例如屏幕截图或点击路径)也可能比较少,进而影响最终文档的质量。

明确项目责任

如果项目责任不清晰,就会使技术作者很难找到自己在项目中的位置。这可能会导致项目无人负责,被挂起,并延长项目实施的压力。

最后一刻的变化

技术作者还必须应对产品特性的变化,这可能在产品上线或即将发货前的最后一刻发生。通常情况下,这是因为技术作者往往只参与产品开发的最后阶段,而这可能会导致匆忙编辑并且可能出现错误。

应对紧急任务

有时候,所有工作都是 “紧急的”。由于公司的某些优先考虑,技术作者经常需要在极其紧迫的时间内完成大量工作,尤其是在临近产品发布日期时。另外,无论计划的时间安排如何,总是会有紧迫的任务出现,需要优先完成而不能改变原来的时间表。

处理与管理者的问题

在技术写作方面,管理者要么管得太细,要么缺乏管理。在这两种极端情况下,有时管理者会控制写作过程的方方面面,从而限制了作者的独立性;反之,有些管理者根本不提供任何支持和帮助,不闻不问。

使用各种工具

有些文档内容是关于高科技的,技术作者必须使用大量工具进行文档开发、编辑、项目管理和图片编辑等。这些复杂的工作流程必然会引起某些问题,包括安装新软件、花时间学习如何使用它、访问相关文件以及转换为其他格式等。

如上所述,技术作者在每天的日常工作中要处理许多不同的问题,从安装必要的工具、在最后时刻进行修改,到与不同的管理人员进行沟通,以及从主题专家那里寻求技术问题的解释等。因此,作为一名技术作者肯定是具有挑战性的,但是,知道你精心制作的文档将会帮助数百万用户时,这一切付出就都是有意义的。

今年 5 月 15 – 16 日将在上海举行的 tcworld 中国大会是技术传播行业最重要的活动之一。届时,CSOFT 华也国际的全球化信息传播总监 Joshua Hughman 将在大会上发表演讲,主题是如何在中国成功管理西方写作团队

另外,5 月 17 日,CSOFT 华也国际将在 CSOFT 上海办公室举办关于技术写作的 Workshop,与到场嘉宾一块儿聊聊内容质量如何影响品牌形象

CSOFT 华也国际全球化信息传播

华也国际的全球化信息传播团队致力于用目标市场当地的语言创作高质量的内容,我们拥有一支背景多元化的母语写作团队,囊括了市场营销、新闻、公关、通信、计算机、生命科学、设计等各个领域的专家。在协助客户拓展海外市场的过程中,华也国际将派出经验丰富的本地化内容专家,确保客户的品牌信息有效地传递给世界各地的消费者。

 

 

Related:  2019年世界品牌500强出炉,中国哪些品牌入围?

Leave a Comment

评论