技术传播概览

本小节将概览技术写作和技术传播的行业概况、行业对此类人才的需求,及其未来的发展趋势。

技术传播概览

技术传播的英文是 Technical Communication,英文的 technical 和 communication 都是多义词,例如communication有传播、沟通、交流、交通等多个含义,因此技术传播,技术沟通或者技术交流等都是可能的解释,而“传播”一词在中文只有一个意思,某种程度上来说中文的技术传播和英文的Technical Communication是不完全对等的。如何能完整的表达原来的术语含义,目前专家们正在探讨,这里我们暂且使用技术传播一词作为整个学科领域的概括。

除了”技术传播“这一专业名词外,大家可能还会经常听到“技术写作”这一术语。事实上技术写作也比技术传播有着更久远的历史,接下来我们将从技术写作开始,逐步介绍技术传播的基本概况。

技术写作

写作对大家来说并不模式,我们每天都会接触到很多写作任务,根据写作目的和读者的不同,常常有如下分类:

  • 创意写作(Creative Writing),打动人的心灵
  • 文案写作(Commercial copy writing),销售产品
  • 商务写作(Business writing),商务邮件、合同、纪要等,便于商务合作
  • 科学写作(Scientific writing),记录和分享科学发现
  • 技术写作(Technical writing),解释工作原理、指导用户完成特定操作

从上方的对比可以发现,技术写作的主要目的是帮助用户完成任务,所采用的手段也常常是基于文本的。技术写作伴随着工业时代而产生,随着设备越来越复杂,以及机械设备的全球使用,提供各种技术资料帮用户使用产品是极为常见的。在新媒体时代到来之前,通过图文的方式给用户提供帮助是最常见的形式。即便是今天,考虑到信息的可即性(Accessbility),传统的说明书依然是各类产品的标配,各类产品标准中也都会规定提供所需的技术资料。

第二次世界大战期间,随着军事技术的迅猛发展,后勤保障逐渐变得复杂,使得标准化流程、定义、描述和培训变得极为重要。二战期间,技术写作引来了迅猛发展。战后,经济的快速发展进一步促进了技术写作的发展。1951年,美国首次出现了技术写作的招聘广告。自1960年后,美国逐渐开始有大学开设技术写作专业。之后随着全球化的发展,技术写作在全世界的需求逐步增加。据不完全统计,全美有200多所高校开设技术写作专业,欧洲有40余所大学开设此类专业,在中国北京大学、东南大学、同济大学、重庆邮电大学等高校已经开设了多门技术写作课程,并正在筹备相应的专业。

相信通过上方的介绍,大家已经能对技术写作有基本的了解。技术写作的核心是给特定用户提供相关、有用和准确的信息,从而帮助用户完成特定的任务。

技术文档类型

技术写作人员的主要职责是创作各类帮助信息,从而便于最终用户或者研发人员利用这些技术信息完成自己的任务,最终交付的成品是各类技术文档。

常见的技术文档类型有:用户手册、管理员手册、参考手册、培训手册、故障排除、FAQ,How to 指南,发布说明等等。

以用户手册为例,一般有三类基本作用:

  • 用户第一次使用产品时,解释如何开始使用。
  • 在用户的后续使用过程中,提供必要的参考信息。
  • 作为安全使用的信息。

其他各种各种类型的手册作用也是围绕用户的需求提供帮助信息,这里不再一一展开。

技术写作的特点

  • 面向特定读者。技术写作总是面向特定读者的,需要分析特定的人群,确定他们所需要的信息。
  • 帮助读者解决问题。读者阅读技术文档的目的与阅读文学作品的目的是不同的。读技术文档的目的是解决问题,而读文学作品的目的是为了愉悦身心。用户一般只在遇到问题的时候才会阅读技术文档。
  • 集体写作而成。技术文档常常是集体成果,这体现在两方面。一是技术写作的输入很多来自于研发人员,二是技术写作工作本身也是多人协同完成。正是因为这一特征,带来了技术文档的模块化和结构化技术,从而便于分工协同工作。
  • 注重信息呈现的方式。技术信息的呈现方式和技术信息本身同等重要。文字的排版,如字体、空格、对齐和颜色等,都能辅助读者快速扫描和定位信息。文字组织也是以读者便于理解的方式呈现,例如多用主动句,句子尽可能简短,多用列表等。
  • 法律责任。技术文档的信息需要准确,还要确保用户安全使用。如果技术文档的信息不准确,导致用户误操作,损坏设备或人身伤害,那么公司是有法律责任的。这一点也对技术写作提出了更高要求。

技术传播

早期,技术写作工程师传递技术信息的主要媒介是纸张,信息的载体主要是图文,进入新媒体时代后,媒介发生了翻天覆地的变化,常见的有电脑,平板,手机,AR/VR眼镜等,传递技术信息的手段也从图文,变成富媒体,可以通过视频、动画、声音和超链接等手段综合提供技术信息。

随着技术的发展,原先的技术写作这一术语已经不能覆盖现有的实践,于是技术传播一次便应运而生,用来描述新时代的技术写作。与技术写作相比,技术传播的目的并没有变化,依然是帮助用户使用产品,只是使用的媒介和手段有了新的变化,给不同用户带来了更大的便利。

美国技术传播协会(STC)对技术传播的定义为:技术传播是一个宽广的领域,所涉及到的沟通和传播至少包含如下特征:

  • 沟通和传递的是技术信息或特定的话题,例如计算机应用程序,医疗流程或环境规章;
  • 使用技术手段进行沟通。手段有,网页、帮助页面和社交媒体等;
  • 提供”如何做某事的说明”,不管这个任务是否有技术含量,或者是否使用技术手段来传递技术信息。

简单来说STC的定义是,只要是指导用户完成任务的所有活动均为技术传播。这也体现了技术传播的核心使命。

典型的技术传播开发流程

为了更好的开发用户帮助,需要以用户为中心,以任务为导向。典型的技术传播产品的开发也遵循现代开发流程,一般会经历如下四个阶段。

1. 需求分析。进行用户调研,弄清楚用户特征、常见任务和基本需求; 2. 信息设计。针对用户的需求,设计恰当的信息提供方式; 3. 信息开发。按照之前的分析和设计,进行技术信息的开发和写作;  4. 信息评价。开发完成后,评价信息产品是否可以达到设计目标。

技术传播从业者需要掌握的知识

技术传播是一个专门的学科,从业者一般需要系统性的学习,才能创建出高可用的技术信息。下方将简要概述各阶段需要掌握的基本信息。

需求分析阶段

有时我们感觉需求分析比较容易,做做问卷就能知道用户想要什么,但实际上是这是比较难的一个过程。用户各色各样,不同的人有不同的需求,甚至很多用户还不知道自己的需求。从业者常常需要比用户更了解用户自己,才能创作出好的技术信息。

这个阶段,需要从业者能掌握最基本的人因学(Human Factors)知识,知道用户的学习风格、记忆机制,解决问题的模式等基本知识。此外信息行为的基本知识也要了解。例如用户遇到问题的时候,会首先自己尝试,其次是问身边的人,再其次打电话给客服或使用搜索引擎上,最后问题依然没有得到解决的话可能才会尝试阅读技术文档。因为自己尝试代价最小,说不定就摸索成功了。问身边的人代价也小,只要问一句,你知道哪里出错了吗?说不定身边的人就知道,问题就得以解决。这个行为模式,实际上背后是人的min-max效应,即人总是喜欢付出最小的努力获得最大的回报,或者最省力原则。知道这点后,我们便知道用户是在什么情况下才开始阅读文档,并通过各种设计方法,方便他们在不愿意看的情况下,快速找到自己需要的信息。

其他还有很多方法论能帮助从业者准确的分析用户需求,如虚拟角色,用户任务分析(UTA),用户任务模型等。总之用户需要掌握基本的心理学和行为知识,才能做好用户分析。

信息设计

设计的最终目的是更好地解决问题。信息设计的目的,也是让用户能以最方便的方式获得信息,在这个阶段也需要掌握一些常见的设计范式,例如解决文档枯燥问题的“情感化设计”,加深用户长期记忆的“叙事(storytelling)模式”,降低用户认知负荷的“渐进式呈现”等等信息设计的常见方法,甚至借鉴其他领域的设计范式。

除了这类设计外,还设计到诸多生产环境的设计,例如实现多人协同工作的“同源开发(single sourcing)”方法,管理信息单元的元数据设计等等。

信息开发

技术传播行业产生了很多成熟的开发技术。在开发或者写作阶段,从业者需要掌握常见的信息开发技术。达尔文信息分类架构(DITA)则是其中较为重要的一种技术。DITA是一种信息分类的方法,DITA 1.3标准中定义了四种信息类型,分别是concept, task, reference 和 troubleshooting,每种信息类型中又定义了各自的结构。按照这种方式写出的文档,风格一致,可以轻松进行复用和重用。除了DITA外,还有一些其他标准例如DocBook和TEI等。上述的常见标准,都是基于XML的。一般而言,从事现代化的技术传播,需要了解 HTML、CSS 和 DTD 以及 XML,XSLT 和 Schema 等信息技术基础才能更好的从事这个行业工作。

除了基于XML的信息开发技术外,现在轻量级的标记语言也在不断普及,例如基于Markdown,reStructuredText,AsciiDoc 等轻量级标记语言。尤其是互联网公司的文档,基于轻量级标记语言的信息开发方式逐渐普及,甚至dita也推出了markdown-dita,从而满足轻量级需求。

取决于帮助信息产品的类型,一些工具型的用户帮助和软件开发并没有太多区别,例如增强现实帮助APP,实际上就是将增强现实用于用户帮助,这需要更多的软件开发技能。信息时代的技术传播也对从业者提出了更高的要求。

信息评价

用户帮助开发好后,需要进行测试和验证工作。常见的有功能测试,如视频能否正常播放,超链接是否能够跳转等,这些功能性测试不少可以由自动化工具辅助完成。此外,还需要在开发过程中或开发之后,进行可用性测试,验证文档或其他帮助形式能否帮助用户完成任务,效率如何,满意度如何等。

在这个环节,从业者需要掌握最基本的评价方法,如启发式评价,内容分析法等等。因为有研究的性质,从业者不可避免的需要能掌握一些统计分析方法,如评价用户体验时的卡方检验,t检验等等,这样才能更好的得出评价结论。

整体而言,信息时代在高速发展,对从业者的能力要求在不断提供,和其他行业一样,也需要不断与时俱进,快速迭代自己的知识结构。

新型用户帮助形式

增强现实。不少汽车如沃尔沃、奔驰等都退出了AR帮助系统,用户无需翻阅说明书,掏出手机直接扫描汽车相应位置,即可获得对应的信息。除了汽车之外,其他领域也有诸多增强现实的应用。

软硬件交互式帮助。用户帮助可以跟产品相连,并能感知用户的操作。例如,小米ninebot平衡车在教用户骑行时,会引导用户下载APP。小米平衡车和app相连后,app中会提示用户按要求练习,而且app能通过传感器知道用户是否执行了相应操作。之前的文档,需要用户自行判断步骤执行是否得当,而这种新型交互方式大大降低了用户的工作量。

嵌入式帮助文档。嵌入式帮助文档是指,将用户使用软件所需的信息嵌入到使用过程中,这样可以:1. 便于用户直观地获得帮助;2.需要时可立即获得所需信息;3. 无需离开当前界面和任务。因为帮助信息并非以传统的文档形式存在,可能称之为嵌入式帮助信息 (Embedded Help Information)更为恰当。

聊天机器人。用户遇到问题时,可以直接询问聊天机器人,机器人可以利用知识库立刻解答用户的问题,这种方式高效便捷,符合用户的信息行为习惯。

小结

总之,技术传播是一个新兴的交叉领域,需要从业者能够掌握语言、技术和领域知识,才能更好的完成技术传播工作。技术信息的提供方式也在不断发生变化,例如由被动检索到主动提供,帮助的形式也在逐步向最省力的方向发展,而传统以文字为主的技术写作因为开发快捷,迭代容易,在研发领域里则继续大放光彩。