万字长文:带你了解华为技术传播的发展历史

编者荐语

本文作者李学昭老师是技术传播行业资深从业者,在华为从事相关工作多年。 李老师通过自己的分享,让国内广大同仁得以学习华为的宝贵经验,助力中国企业打造具有国际竞争力的产品和服务并走向世界,难能可贵。推荐!

以下文章来源于公众号《技术传播研究猿》 ,作者李学昭


2005年,早春二月。我在西安郊外的白鹿原上接到了华为的面试通知。当时我在一家小公司做加拿大北电网络(Nortel Networks)的无线网络技术督导,已经看到华为在缓慢地进入陕西市场。那是我第一次知道这个世界上还有一个工作岗位叫“资料开发工程师”。当时我并不知道,这个业界称作“技术传播”的行当,华为已经走过了十年之久。

作为一个职业,技术传播的历史并不长,技术传播在国内仍然稚嫩。华为的技术传播历史不足30年。这段历史当然算不上波澜壮阔,但也有颇多值得回味的地方。

 

 

7d94b09214f47dca143a03f44d34df95.png

***

一切开始于1995年。华为公司编委会第一任总编徐少敏在一次访谈中说:“刚开始是让费敏来挂名,然后我们作为第一批员工到编委会。刚开始在编委会的时候大概只有三四个人。我们原来是搞产品开发的,突然来写资料,完全没有概念。”

 

e3c2403e3c8c447d7226a1ce763cc419.png

很多年以后,“资料”仍然是华为人对技术传播的称谓。本文中的“资料”即是技术传播在华为的行话。

1996年6月,公司编委会正式成立。编委会归属于当时的中研部,主要职责是资料编辑,脱离产品开发团队集中办公,大约30人。

1999年2月,编委会更名为编辑出版中心,隶属于技术支援部,主要职责是资料编审,部分参与产品开发,约100人。

2000年5月,编辑出版中心更名为资料开发部,并重新隶属于中研部,负责各产品领域的资料开发和翻译工作。资料开发部设有总部和分部。总部集中,下设总编办;分部则分散到产品开发团队中,总计约150人。

2006年12月,再次调整组织结构,确定了“集中规划、分散开发”的模式。在中央平台开发部下设立资料开发研究管理部,承担资料行业管理职责,负责资料领域的能力建设、工具与发行平台建设、最佳实践共享、新技术引进和翻译服务。在各产品线下设资料开发部,负责各产品领域的资料开发工作。此时总人数突破1000。

2008年,资料开发研究管理部更名为资料开发管理部,作为行业管理的秘书机构,负责行业管理制度建设、重点工作推动、行业测评、最佳实践共享、能力建设、工具开发、翻译服务、发行服务、任职培养等具体工作的组织实施。行业管理是华为公司的技术管理手段,目的是通过新技术研究引进、经验交流、能力共享来牵引技术方向,提升整体能力水平。几乎所有你能想到的技术领域,软件、硬件、测试、UCD……都有行业管理组织(后来称为“技术委员会”)。

2009年,各产品线资料开发部更名为产品线资料部,肩负起产品包资料整体交付的责任。

2018年起,各产品线资料部陆续更名为信息体验部或内容体验部。

***

个人兴趣所限,我会更倾向于关注技术传播能力的发展。我把这不足30年的历史大致分成几个阶段;这几个阶段在时间上略有重叠,一些实践可能贯穿了多个阶段,我想突出的是每个阶段的重心。

阶段1

艰难的起步(1996~1999)

编委会成立以后,首先是组建团队。当时从技术服务部内招了一些同事,也从国内各邮电院校招聘了不少老师,按照培训和教学的思路编写文档。人数少,技能弱,编委会的主要工作是“来料加工”,对研发专家提供的内容做技术编辑。至少到2000年,产品文档的大部分内容都还是由研发工程师和服务工程师写作,资料工程师负责编辑、评审、翻译和发布。

1997年,华为参考美国AT&T公司的数字程控交换系统5ESS,制定了最初的资料体系,包括技术手册、操作手册、运行手册、维护手册、安装手册、验收手册共6种文档,俗称“六本书”。C&C08是华为自主研发的第一台数字程控交换机,对于华为公司和整个通信产业都有着非凡的意义。当时电信业执牛耳的是AT&T。华为的第一个资料体系,选择学习AT&T的同类产品5ESS,也就非常好理解了。据说C&C08的命名就是模仿了AT&T。

在后来的话语里,“资料体系是华为公司客户文档的分类、定位、彼此关系和设计思想或原则的企业规范。”“六本书”构成的第一代文档体系是一个简陋但还算成功的开始。时至今日,很多资深的产品经理和研发主管对这个领域的认识也还停留在“六本书”阶段。不知是幸或不幸。

这个时期的一个典型事件是“华为技术与产品入门”系列丛书的编写。1999年,华为公司编委会与邮电院校合作,编写了“华为技术与产品入门”系列丛书,深入浅出地介绍了华为产品的原理、结构、特点和业务性能等,尝试用通俗易懂的语言将复杂的电信网络展现在具有不同知识结构的读者面前。丛书以光盘的形式发送,包括:《通信技术概论》《程控交换技术》《智能网》《SDH光传输技术》《数据通信技术》《无线通信技术》《ATM技术》《接入网技术》《电信支撑网》。主编徐少敏,编委包括钱为民、程加斌、韩献光、王永平、罗浩、常占红等。

阶段2

自主的桌面研究与应用(1999~2005)

资料开发部总编办启动了海外经验的学习研究与引进工作,主体是英文书籍的编译引进、行业标准的研究,并在此基础上形成自己的企业规范和文档体系。

海外技术写作书籍的编译研究

华为技术传播领域启动海外先进经验的研究与学习工作,第一个目标是公开出版的技术写作书籍。2000年,总编办时勃等人启动了的研究工作,并于2001年编写了一本名为《手册写作技巧》的内部书籍,用于指导文档编写工作。这本书是技术研究的一个总结性成果,其内容主要来源于以下5本书。

1. Writing Software Documentation: A Task-oriented Approach, Barker T. Thomas, Allyn and Bacon Press,1997

这本书是Texas Tech University为Technical Communication专业的大学生和研究生编写的教材。

2. How to Communicate Technical Information: A Handbook of Software and Hardware Documentation, Price J., Korman, H., Addison Weisley Press,1993

这是一本关于如何进行手册写作的经典著作,最初是出版于1984年的How to write a computer manual: a handbook of software documentation,书里收集了几乎所有的关于如何进行资料开发的观点。

3. Developing Quality Technical Information: A Handbook for Writers and Editors, Hargis. G., Prentice Hall Press,1998

这本书(DQTI)是华为长期学习的经典著作,业界俗称“技术写作圣经”。《手册写作技巧》的第1章内容是从这本书里摘编的。

4. How to Write Usable User Documentation, Weiss H. Edmond, ORYX Press,1991

这本书第一版叫How to Write a Usable User Manual。该书提出的“手册结构化设计”的思路和开发方法、关于“格式化文本”和“模块化”的描述,给华为人留下了深刻的印象。

5. Practical Approaches to Usability Testing for Technical Documentation, STC Press,1995

这是美国技术传播协会STC(Society for Technical Communication)出版的关于“Usability Test”的一本小册子。

如今,这些书籍可能还藏在华为图书馆的某个角落里。

在这一阶段,华为在技术传播领域的发展以自主研究和自主学习为主。海外优秀的技术书籍为华为带来了先进的理念和方法,影响深远。尤其值得一提的是DQTI。自2003年起,以DQTI为基础开发的培训赋能课件《开发高质量技术信息》就是华为技术传播领域长期开设的基础课程。几乎每一个新入职的员工都受到它的影响。华为也是在这本书的直接影响下,建立了用户视角的资料评价体系(3E)。

 

fe49ef081d010be71eb9c3e451165608.png

遗憾的是,此后很长的时间里,《手册写作技巧》被绝大多数人忽视了。十年之后的2010年,朱炜在数据通信资料开发部组织写作实战训练营。训练营中,《基于逻辑思维的写作》还隐约可见《手册写作技巧》的影子。比如,关于“文档的目的是控制”的说法,就来自《手册写作技巧》,其思想来源则是How to Write Usable User Documentation

友商学习与行业标准研究

在华为技术传播的发展过程中,学习友商是一个坚持了多年的方法。学习的友商多为通信领域的竞争对手,如西门子、爱立信、诺基亚、IBM等。当年主要是采用标杆分析法(Benchmarking),通过分析友商的文档成果,来发现改进方向、制定改进策略。时至今日,学习的范围和深度都有了极大的变化。随着友商学习的深入,学习范围也不再局限于静态的文档,而扩展到组织结构设置、人员能力模型、信息开发流程与方法、信息架构、开发工具等等。

这个时期,还启动了对行业标准的研究与应用,这也是华为在走向国际的过程中必然要面对的。当时主要关注的是软件和系统工程领域的国际标准和电信行业的标准,包括ISO/IEC 15910:1999、ISO/IEC 18019:2004、IEC 62079:2001、ISO 9241、IEEE Std 1063-2001、BS 4884:1992、GR-454等。行业标准中通常都定义了文档的设计与规划的一般原则和详细要求,其范围包括文档的内容、结构、版式设计、术语、插图、警示标识、写作原则和方法论等等。行业标准提供了基本的要求,是华为企业标准的重要输入。

企业规范制定

华为公司早期的一个习惯是,把研究成果与实践经验以企业规范的形式发布,技术传播领域也不例外。企业规范以国际通用的技术标准为基础,结合了友商分析成果、运营商合同与标书的要求、项目所属国家和区域标准等。企业规范支撑了各个技术领域的活动,是走向成熟的标志。

这一时期,有一件事对华为的发展影响深远。2003年1月23日,美国思科公司正式起诉华为公司及华为的美国分公司,要求华为停止侵犯思科知识产权。思科认为华为路由器产品在命令行界面、用户手册、帮助界面等方面侵犯其知识产权。在正式起诉之前,2002年下半年,双方就已经展开协商。其实,华为早就意识到知识产权的重要性,并在1999年递交了第一份美国专利申请。但是在技术传播的起步阶段,对知识产权的理解还不到位,在学习和借鉴国外友商的过程中,不可避免地带有一些形式上的模仿,甚至有的文档中使用了思科的图标。此后,华为重新设计了文档模板,并于2003年发布了华为风格手册、图形规范和图标库使用规范。(张玉祥,我在华为资料十年,2011)

华为风格手册是华为的公司级标准,标准文号DKBA1313-2003.12。DKBA是国家标准局分配给华为的企业标准代号。华为在技术传播方面的企业规范除了上述规范,还包括资料体系、术语规范、IPR规范、索引制作规范、发行规范等等。

 

1ff35783a2923f38fd2e7fffdfd36a2d.png

资料体系更新

1999年-2000年,参考西门子公司的文档体系,华为资料体系增加了描述类文档(如设备手册、用户手册、命令手册),种类达到了11本,并统一了各产品的资料体系。2003年,资料体系再次更新,种类达到19本,并接管了软件产品联机帮助的开发(这也为后来引进DITA埋下了伏笔)。不过,相对于后来的《售后客户文档体系5.0》来说,这两次资料体系的更新就显得不那么重要了。

2005年,华为传送和接入产品进入英国电信(British Telecom,BT)的短名单。当时,BT决心投入巨资建立面向21世纪的网络,即BT 21CN项目。中标带来的不仅是喜悦,还有高端运营商严苛的要求——当时参与此项目的许多人直言BT 确实“BT”。此后不久,华为陆续进入更多高端运营商(俗称“大T”),如PCCW(香港电讯盈科)、TI(意大利电信)、KPN(荷兰电信)、FT(法电)、DT(德电)等等。每一个项目的交付,都是无数次的标书分析、国际标准研究(标书中要求文档遵循国际标准)、文档定制、测试验证。大T的严苛要求,最终变成了文档需求基线,成为指导文档设计与写作的重要输入。(解明震,资料十年,2012)

2005年底,易宏主持启动《售后客户文档体系5.0》的制定,次年1月正式发布。同步发布的还有写作模板、指导书和Checklist。

《售后客户文档体系5.0》将产品文档分为解决方案及系统、产品两个层面,每个层面又分为描述类、过程类和参考类三种类型。

  • 描述类文档提供产品、系统或解决方案的基本组成、物理属性、功能特性、接口、应用或某个专题的完整特性的描述信息,主要参考标准是IEC 61346。

  • 过程类文档按客户网络的运营过程和子过程展开,以step-by-step的形式描述产品的应用过程。过程类文档的主要参考标准是GR-454。

  • 参考类文档提供专题的支撑信息,这些支撑信息是客户在完成任务和理解产品信息时所需要的详细记录和解释信息。参考性文档所含的信息可独立用于其它文档。

     

这次文档体系更新,是充分分析大T标书需求、对标业界标杆友商文档和体系、研究国际标准和电信运营模型的结果。《售后客户文档体系5.0》明确其设计原则是:“以大T客户需求为依据,以友商文档体系为参照,符合资料体系的国际标准。”

显然,华为经过几年的磨炼,已经取得了一定的进步。但是,遵循国际标准、满足客户需求、对标主要友商,只是成长的第一步。

阶段3

持续引进海外先进经验(2004~2013)

在这一阶段,友商学习和Benchmarking工作更加深入。学习和研究的对象仍然以爱立信、诺基亚-西门子、ALU等电信设备商和IBM为主,但是范围扩展到了组织结构设置、人员能力模型、信息开发流程、信息开发方法、信息架构、工具平台等等。

2008年,在徐直军的直接领导下,PSST制定了产品包资料的战略,要求对内支撑低销售成本、低服务成本,对外提升客户满意度,具体目标就是8按:按资料安装、按资料数据配置和网络调整、按资料软件调测、按资料软件升级、按资料软件打补丁、按资料日常维护、按资料问题处理、按资料投标和点对点答复。

在可服务性委员会主导的后来的版本中,8按升级为7远8按,7远即远程调测、远程升级、远程打补丁、远程网络调整、远程故障处理、远程日常维护、远程数据配置,8按则去掉了按资料投标和点对点答复,按资料数据配置和网络调整拆分为两个。

同时,成立两级资料管理委员会(公司资料行业管理委员会和各产品线资料行业管理委员会),由研发、GTS、Marketing、行销、培训中心等领域协同推动资料工作。资料活动融入IPD流程,资料开发计划成为产品开发计划的一部分,根据资料测试产品,明确资料问题属于产品问题等等。“资料是产品的一部分”的理念,从此深入人心。此外,针对交付乱象,还启动了“统一出口”活动,把资料开发部的职责扩大到交付给客户的所有文档,确保产品包资料以相同的规范、在统一的平台,向客户交付。

不过,这一阶段最典型的特征是海外先进经验的引进。华为多次聘请业界顶级的顾问公司和技术传播行业专家,组织小范围、面对面的短期研讨。通过研讨深入理解和掌握先进理念与方法,并推广到整个公司。同时,华为还积极参加行业会议,与业界同行交流。华为也开始举办资料技术交流大会。首届资料开发技术交流大会于2005年11月举行,以内部交流为主。从2013年起,资料开发技术交流大会更名为华为信息论坛,转变成了“外部专家开天窗+内部经验分享”的模式,由各产品线资料部轮流组织,并持续至今。

这是华为技术传播领域能力快速积累和快速发展的关键时期。华为不仅在业界较早转向了DITA架构,还先后引入了信息映射(Information Mapping®)、整体信息体验(Total Information Experience,TIE)、最小化(Minimalism,国内通常称为“极简主义”)、用户和任务分析(User and Task Analysis,UTA)等行业方法,从而快速赶上了国际先进水平。

信息映射

从2000年起,华为与摩托罗拉开始了长达十年的亲密合作。1999年前后,摩托罗拉在跟爱立信和诺基亚的市场竞争中逐渐失利。为了弥补产品竞争力的不足,摩托罗拉寻求与华为合作。具体来说就是,摩托罗拉贴牌转售华为的无线网络产品,最初是核心网,后来扩展到基站和基站控制器。(华为公司,尊重和保护知识产权是创新的必由之路——华为创新和知识产权白皮书,2020)

2004年初,摩托罗拉公司的资深文档专家Simon Butler为华为做了为期14天的文档培训。那很可能是华为与业界专家的第一次亲密接触。正是在这一次培训中,华为人第一次听说信息映射。这直接导向了信息映射理论的学习。

其实,在更早的2003年,华为已经聘请业界知名的咨询公司Sigma做针对性的文档分析诊断。在一份针对M900/M1800 MSC/SSP/IP Operation Manual – Routine Operation的分析报告中,已经提到了信息映射方法,不过当时没有引起足够的重视。

2004年,陈圣权、王旭东、黄影等人去吉隆坡参加了Information Mapping公司授权机构的培训,并在公司内推广。这是华为最早开始跟业界先进思想和专家的面对面学习。信息映射一直是华为比较重视的一个方法论,这方面的培训持续了好多年。但是,方法论的应用效果并不理想。很多人反映,信息映射方法太抽象了,哪怕经过培训,也很难在实际工作中运用。相对来说,DITA的引进和落地就顺利得多,也成功得多。不过,从业界咨询公司和顶级专家引进海外先进理念的进程,就此开始了。

DITA

同样是在2004年的培训中,华为从摩托罗拉专家处知道了使用XML编写文档、使用DTD(Document Type Definition)控制结构、使用FOSI(Formatting Output Specification Instance)设定格式的文档开发方式:DITA。当时,摩托罗拉转向使用XML开发文档还不足两年。

与此同时,华为公司在高端市场的突破,面临着一场从中国走向全球的攻坚战。客户既要联机帮助,又要光盘和纸件;多产品型号多版本并行开发;定制需求和多语种要求层出不穷。当时的开发工具效率低下,难以应对。2004年,华为启动新资料架构与工具的选型与研究工作。在当时的背景下,工具引进和IT系统集成是第一目的。2005年5月,韩献光到美国西雅图参加STC第52次峰会,亲眼看到IBM安排了密集的演讲,并在跟业界同行的交流中了解到基于XML开发的趋势。在这次会议上,韩献光还与DITA最重要的鼓吹者Michael Priestley交流,并通过他了解到后来对华为影响深远的JoAnn Hackos博士。

 

892d8044cf26ded899551b11b016c5be.png

杨檑敏锐地意识到,DITA“极有可能成为IT、通信行业资料开发的标准”。韩献光感慨道:“多少年来同行们追求着资料模块化、同源的理想开发模式,而现在DITA已经向我们奔来,我们有什么理由不选择她呢?”(杨檑,基于DITA的内容重用模式研究;韩献光,华为资料架构的未来之选,STC 52nd Annual Conference(USA)总结)

2005年底,华为聘请IBM公司专家到深圳实施为期4天的DITA研讨。然后,传送网管T2000和接入网等作为试点产品,开始了DITA迁移工作。DITA的引进是一个痛苦的过程。一切都是崭新的,新的设计工具(自研配置计划工具,用于制作文档大纲和生成ditamap)、新的写作工具(Epic Editor,后来被Arbortext收购,用于编写XML文件)、新的写作规范(适应XML格式写作)、新的多格式发布平台(Multi-Channel Publishing System)。

在DITA的引进初期,为了保证按时交付文档,工具平台和格式转换是最先需要解决的问题。试点项目实现了多格式发布,也逐渐催熟了发布平台。但是,作为一种新的信息架构方法的DITA,被表面上繁重的工具属性掩盖了。因为缺少理论指导,DITA的能力并没有得到发挥,基于DITA的写作也不尽如人意。这也是DITA容易落地、但很难用好的一个原因。

除了IBM的帮助,华为也通过行业会议了解业界的先进经验,如DITA Europe 2007、Content Management Strategies/DITA conference 2008等。在2008年的会议上,杨檑还做了题为Implementing DITA in the Real World的演讲,向业界分享华为的经验。

信息架构、TIE和UA

大概是2005年,华为从业界了解到信息架构(Information Architecture)理论,并设置了IA(Information Architect)这个岗位,但是对于信息架构的理解,对于信息架构师的职责,都很模糊。2007年,易宏老师经过深入研究,系统梳理了信息架构的发展历史和重要思想,给出了发展方向。(易宏,信息架构理论在华为的应用及后续工作建议,2007)

易宏主导了基于任务的资料模块化设计项目,探索用户任务分析与结构化设计的结合,引导从面向产品向面向客户任务的转变。基于任务的资料模块化设计方法在2010年的CIDM Best Practice大会上获得了行业专家肯定,并在CIDM官网上发表。(易宏,技术专委会系列宣传之群英汇,2012)

这一时期,华为制定了信息模型框架、文档模板、导航规范、链接规范,研究了信息分类方法和搜索技术。同时还启动IA系列培训课程的建设,包括《模块化&结构化设计理论》(易宏)、《最小化设计理论》(陈阅军)、《信息架构和信息模型理论》(刘洁)、《用户体验》(梁秋霞)、《按角色/场景设计》(韩献光)等。

这里特别提一下按角色/场景设计。2004年,华为在IPD流程中融合了UCD方法,UCD研究部设计了一天版的Mini培训课程。2005年邀请IBM公司顾问Susan Smith、Michael Heck和David Miller组织UCD研讨会,此后不久开始在公司范围内推行。作为IDP流程中的一部分,华为技术传播领域应用UCD方法的过程与研发体系同步,IPD流程中也定义了IA和TW的活动。按角色/场景设计,是将UCD方法应用于信息架构与信息设计的尝试。在不久以后,华为就引进了更具有直接指导意义的UTA方法。同一时期,技术传播领域还在文档的可用性测试方面展开探索,并通过Nopsar咨询公司引进了爱立信的CRT(Clean Room Test)方法。(薛坤,Clean Room Test资料测试方法介绍V2.0,2008)

CRT方法,由选定的测试执行人员模仿最终用户,通过标准的版本交付流程,获取版本和资料,在实验室镜像的现网真实环境上,在真实的用户场景中,按照资料描述的流程、步骤测试产品,严格按照资料操作,以评估和验证产品和资料的可用性,同时评估交付渠道和求助渠道。CRT测试是全流程的测试,可以发现更多客户面可能遇到的问题,效果好。但是CRT测试的投入巨大,在推广中很难做到绝对的镜像和真实。

2009年4月,华为聘请IBM公司高级专家接连组织了两场研讨会,每场持续5天。这两场研讨会对华为技术传播的发展影响深远。

首先,由IBM公司信息体验策略师和架构师Andrea L. Ames组织信息架构研讨会。这是一次深入而系统的学习,Andrea不仅阐释了信息架构模型的概念,介绍了如何创建信息架构模型并使用它设计一致的信息体验,还介绍了UA(User Assistant)、基于场景的设计、信息策略、信息体验设计等方法。此外,Andrea还回答了学员大量的问题,其范围从如何与开发人员合作到IA融入研发流程,从组织设置到角色定义,从用户需求分析、设计到IA技能培养,等等。

随后,由IBM公司用户体验架构师Jamie Roberts组织TIE研讨会。TIE整体信息体验,把视野扩展到公司对用户交付的所有文档。IBM以TIE作为Content Strategy的同义词,并以5R作为目标。从此,华为的评价体系在用户视角之外又增加了开发者视角。

Our goal is to provide the right content to the right person, at the right time, in the right format, and in the right media -- driving faster customer implementation of our IBM offerings and decreasing the time-to-value. (IBM,Total Information Experience,2006)

这次研讨既有TIE信息模型、内容委员会、集成集成内容计划等宏观指导,也有Technotes、SEO、自动检查工具、模板专门化等优秀实践。当年,华为就根据IBM公司的TIE实践指导,设立了产品包资料委员会、服务资料委员会、销售资料委员会,试图通过三个资料委员会的运作,构建华为的整体信息体验。然而,三个资料委员会的设立本身就已经证明,它们并不能实现整体信息体验。这当然是一个悲伤的故事。

早在2005年,华为就注意到了UA,但直到此时才意识到UA与TIE的相通之处。2009年,华为参加了UPA(Usability Professionals' Association)组织的User Friendly 2009用户体验大会、UA continuum 2009,次年参加了WritersUA大会。UA把华为的视野从文档扩展到EA(Embodied Assistance)、eLearning、多媒体、用户社区、论坛、800客服热线等。一个直接的影响是,华为定义了自己的UA Continuum,并要求在需求分解阶段,把信息需求分解到不同的呈现媒介上。UA Continuum是一个同心圆模型,从用户界面、在线帮助、教程类帮助过渡到技术支持网站等辅助信息平台,以及随机发货的纸件和光盘。相当于,把注意力向前扩展到产品本身,向后扩展到信息交付平台和售后服务。当时在UA方面研究与实践最成功的是电信软件业务,但是受限于业务面向的运营商客户,其重心更多地是UI和各种联机帮助的设计。向后的扩展,来的要晚得多。

TIE和UA打开了技术传播的视野,为后来百花齐放的探索埋下了伏笔,这是它最大的功劳。

最小化和UTA

关于最小化(华为内部把Minimalism称为“最小化”,而没有采用“极简主义”,或许是因为后者已经在艺术与个人生活方面产生了巨大的影响),据说早在2002年,在同IBM的合作项目中,华为就从顾问那里知道了这个概念。2006年同JoAnn T. Hackos博士合作中又被推荐:最小化是一种重要的资料交付件设计方法论。

最小化是John M. Carroll在IBM沃森研究中心工作时提出的一种学习型理论,最早可追溯到1970年代。1990年,Carroll出版了The Nurnberg Funnel: Designing Minimalist Instruction for Practical Computer Skill,首次向业界系统性地介绍了最小化思想。1995年,Carroll在STC的资助下组织了一次研讨会,众多业界大神参加了这次研讨,Carroll把与会者的论文编辑成了一本书,Minimalism Beyond the Nurnberg Funnel

 

23826558cec6d4819d6f4b23d6194862.jpeg

2007年,华为确定最小化为年度技术项目,最初是通过互联网寻找相关的资源,后来从美国购买了Corroll的两本书,组织阅读、吸收和实践,形成了一套培训教材。2008年,业软资料部确定“最小化的推行和落地”为技术项目,并在SMSC产品试点。(刘永国,Minimalism对资料开发的启示, 2007;刘永国、陈阅军,Minimalism培训胶片,2007)

这是华为早期工作方法的延续,仍然可以看到努力自学业界先进经验的工作思路。不过,自学的效果,在理念和理解和应用层面,都不能让人满意。作为一种理念,最小化的应用效果同信息映射一样,不像DITA那样立竿见影。

2011年2月,华为聘请咨询公司Comtech Services的JoAnn T. Hackos博士组织最小化和UTA研讨会,为期4天,无线、传送、电信软件、中央软件等多个领域参与。JoAnn T. Hackos博士与Janice C. Redish都参与了1995年的研讨,始终关注最小化理论的发展,并合著User and Task Analysis for Interface Design。在一次研讨中先后讨论最小化和UTA,显然是把用户界面设计的方法移植到了文档设计领域。最小化是一种理念,告诉技术传播从业者在设计和开发信息时应该增强什么、应该减弱什么和应该舍弃什么。具体到一个项目的执行,则需要更多的用户分析和任务分析,这正是UTA。UTA把最小化思想具象化,让最小化的应用更有可操作性。

结构化写作与同源

从2005年正式引进DITA以后,华为多个产品线在两三年内完成了DITA迁移,并普遍采用基于Topic的结构化写作方法。多年的实践积累了经验,也存在不少问题。从2011年到2013年,华为先后多次邀请咨询公司为结构化写作赋能,反思DITA引进过程中遗留的历史问题。

2011年,聘请TRG公司(The Rockley Group)总裁、内容策略专家Ann Rockly针对华为文档开发现状实施审计,分析华为如何创建、管理和交付内容,评估内容质量、结构以改善内容重用,并给出了工具规划建议。项目的第一阶段,Ann Rockly首先抽检了传送产品线的Topic,发现Topic粒度偏大、Topic类型错误、Topic标题不准确和短描述(Short Description)定位不清晰等问题,并在2011年5月组织了研讨会。在项目的第二阶段,Ann Rockly抽检了无线产品线的Topic,并以课堂演练的形式,讨论了Topic-based Writing、Structured Writing和Writing for Reuse等主题。最后,Ann Rockley提供了Structured Authoring Guidelines,作为针对性的改进建议。

2012年,聘请Comtech Services, Inc.公司JoAnn T. Hackos博士培训Structured Writing for DITA,并组织了以信息建模(Information Modeling for Topic-based Authoring)为主题的研讨会。Hackos博士系统介绍了基于DITA的结构化写作方法,并深入探讨了信息模型和信息分类的意义和方法。

2013年初,华为收集了结构化写作中的具体问题,再次邀请Hackos博士深度咨询。Hackos博士审查了XML源文件(Code Review),从具体问题入手,给出了改进建议。涉及UTA、Topic颗粒度、链接策略、短描述的写作、信息类型、重用策略、Metadata策略等具体问题。

2013年,华为组织了结构化同源开发研讨会,并正式发布了《资料结构化同源开发方案》,包括开发流程、写作规范和培训体系。作为一系列实践和研讨的成果,结构化同源开发方案包括了UTA、信息需求分析、ATL(Annotated Topic List)、信息模型与结构化写作、内容重用指导、Metadata规范、搜索设计、链接设计与实现、代码审核、质量度量,是一次系统的流程和规范梳理。

阶段4

向企业业务的多样化探索(2011~2018)

2011年,华为成立企业业务BG,由此进入了企业IT和数字化技术市场。这是华为业务转型的关键时刻。在这个大背景下,华为技术传播领域也进入了新的阶段。这一时期,华为更多地通过自主探索来获得新的方法与新的思路。从以运营商为主要客户、以电信设备商为主要学习对象的时代,走向了更加开放、更加多元的新时代。

百花齐放春满园

企业业务是一片全然不同于运营商基础网络的新天地,基于电信管理模型建立起来的资料体系已经不能适应新的需要。面向企业业务市场的技术传播,需要适应新的销售模式和运维模式,适应企业用户的工作习惯和阅读习惯。

当时,我在华为与赛门铁克组建的合资公司负责网络安全产品文档团队,根据实践经验与客户交流,广泛调研企业市场的标杆友商(思科、Juniper、Fortinet、EMC等),结合企业市场的特质,从销售模式、用户角色模型、信息获取模型、运维服务模式等方面,审视华为文档体系的弊端,思考能力建设与组织调整的方向,并在2011年的第五届华为资料技术开发大会上发表《面向企业业务的技术传播之路》。这是华为第一次系统地考虑面向企业市场的技术传播,不仅提出了产品文档的架构调整建议,还呼吁重视产品易用性/UI、知识库建设、培训与认证体系、多媒体与直播(webinar)、客户需求管理、论坛与社区运营、服务工具开发等。

翌年,华为技术传播领域组织了第一次针对企业业务的研讨。以前只有数据通信产品线关注的思科开始成为公司级的研究目标,而信息体验领先的小厂商Juniper也终于走进了大众的视野。2013年,易宏深度调研和解析了Juniper公司的开发实践与用户体验。范围包括组织职责、人员技能模型、信息体验变革、内容策略、内容架构、支撑平台、网站、搜索与导航技术、多媒体、移动App、公共出版物等等。华为北美资料团队则扎根技术传播最先进的美国,积极参加行业活动,了解业界动态。2016年,华为还通过JoAnn T. Hackos博士担任主席的信息开发战略峰会(Information Development Strategies Summit)会议,调查北美地区对标企业厂商在技术传播领域的优秀实践。

这是新技术快速发展的时期。iPhone的发布,社交媒体的发展,3D技术的进步,为技术传播带来了无限的可能。从这时候开始,华为仿佛进入了一个新的世界,打开了技术传播的新视野。华为开始实战化、移动化、碎片化、轻量化、情感化、个性化、图形化、工具化……等新方向的探索。

基于实战经验的文档品类不断扩大,用于指导业务配置的典型配置案例、用于指导方案规划和部署的最佳实践、用户指导运维的维护宝典和TechNotes,都是基于知识管理方法,从一线服务工程师和交付团队收割的知识。

为了让用户可以随时随地方便地获取技术内容,华为开发了技术支持App,完成了技术支持网站的移动化改造。为了提升产品使用体验,华为借鉴了WalkMe和Wix的理念,开发了WalkFast体验平台,可以在软件界面上提供Step by Step向导式的帮助信息,在用户完成任务过程中给予适时的提示,降低软件的使用门槛。以前,软件产品的易用性提升受限于软件开发团队。WalkFast让用户体验提升跟软件工作解耦,为技术传播开辟了一个新的战场。在此基础上,华为还开发了iTeach仿真交互教程开发工具,通过模拟Web软件真实页面、用户操作行为和软件的响应,让用户在操作过程中学习使用软件。使用iTeach开发的教程可脱离于软件环境使用,适用用于客户软件演示、培训赋能、测试认证等。

更重要的是,华为开始使用新的形式和新的渠道来提供内容,试图转变过去运营商文档呆板的面目。这一时期,视频的数量和种类都有了爆发式增长,3D模型成为硬件产品的标准配置,技术导图、海报、信息图、漫画、H5动画等图形化形式此起彼伏,问答机器人、AR、VR等先进技术的应用提升了用户体验,社交媒体的应用拉近了用户的距离。

精品内容为华为技术传播带来了极大的声誉,提高了内外影响力。这其中最值得一提的是安全团队策划的《强叔侃墙》系列技术贴。从2014年3月,第一篇帖子在华为企业互动社区发布,到当年12月第一季收官,《强叔侃墙》系列技术贴因语言轻松幽默、技术讲解透彻,收获了百万浏览量。实体书出版迅速提上日程,并于次年上市。

在精品内容的建设之路上,华为持续拓展技术精粹(画册)、实体书籍、eBook小册子、知识百科等新的形式,逐渐切入内容营销领域。

 

7de8459261392666ec8c02a5bb916e3c.png

这些内容,不仅为产品和解决方案的上市推广提供助力,也成为提升品牌影响力的重要举措。面向不同用户群体,提供不同深度的技术内容,构建由浅入深的内容生态,取得了初步的成果。

面向未来的信息架构

转型期间,大量的新技术层出不穷,很多团队进行了很多有益的、成功的探索。但是,一边是大量新技术、新技能需要探索和消化,另一边是繁重的项目交付工作。如何权衡,才能实现有序、高效、平稳过弯?海量的内容,应该以什么渠道提供给合适的人,让用户更容易获取到我们的内容?如何让内容以更合适的格式、更合适的媒介出现,以便用户更喜欢阅读?华为人开始重新考虑5R的落地。

这就需要构建一个面向未来、前向兼容的产品信息架构。2014年,易宏主持制定新的信息架构,并于2015年正式发布Smart-Info 6.0。Smart-Info的核心策略是像开发软件一样开发产品信息,将产品信息等同软件代码进行需求分析、架构设计、开发、测试验证和发布。Smart-Info方法论是华为首创的一套资料设计开发方法论(包括方法、流程和工具),支撑智能内容的转化、生成和使用。

Smart-Info的设计理念是化繁为简、自顶向下将产品逐层解构为用户视角的产品组件,然后对产品组件进行抽象分类构建产品模型,再在产品模型的基础上构建基于产品组件的信息模型,保障每个产品组件都有其对应的信息组件。通过结构化的信息及其语义化属性,实现自底向上的资料的随需装配,并开放给不同的系统 工具进行智能使用。

Smart-Info采用分层解耦的设计方法,将产品信息开发定义了用户层、内容层、表达层、交付层、获取层五个层级。各层聚焦用户体验的不同特征,彼此独立,分层迭代时不影响其它层的特征,方便实施信息需求分析和信息架构设计。

  • 用户层(Right people):明确产品信息需要支撑的目标对象,通过5W1H方法分析产品信息的内容、表达、交付和获取需求。用户层注重信息获取的需求分析活动,注重应用场景。

  • 内容层(Right information):在用户层信息需求分析的基础上,设计产品集合的信息组件模块库和标准信息交付件Map。基于产品描述对象的信息组件库和标准信息交付件设计分离,支撑重用和按需组装。

  • 表达层(Right formats):以内容模块为对象,定义最合适的表达形式。

  • 交付层(Right channels):以用户角色和获取产品信息的场景为基础,定义用户界面产品信息的交付渠道的全集。

  • 获取层(Right time):根据不同的产品信息交付件、交付渠道,采用搜索、导航、动态自动聚合等技术手段,提升易获取性。常见的信息获取方式包括搜索、导航、目录、链接、聚合推荐信息等。

在多年实践探索的基础上,Smart-Info把多样化内容与传统文本融合在一起,也把3E和5R结合在一起,用一个清晰明确的整体架构,建立起了整体信息体验流程。

阶段5

数字化驱动智能化发展(2018~至今)

这一阶段的总体策略非常明确:数字化和智能化“双轮驱动”的用户体验。其中,为用户提供智能化的应用是用户体验的目标,而数字化是智能化应用的基础。连接数字化与智能化的,是信息交付流水线。因为,庞大的数字化信息需要流水线的方式自动化生成,才能保证高效、精准。

要实现这一目标,大体上要做四件事。

第一件,定义智能化信息体验目标。宏观的信息体验目标就是我们想要给用户提供什么样的使用体验,具体来说可能是智能搜索、自助问答等能力或应用。数字化转型困难重重,从信息体验目标出发,是为了避免在无意义的工作中消耗热情。

第二件,定义信息模型。为了支撑上层的智能化应用,必须合理定义信息模型,即以智能化体验目标为起点,确定信息模型(即信息建模)。信息建模是数字化的关键,统一的信息模型是智能化的基础。技术规格类信息和OM(Operation and Maintenance)类信息(如命令、日志、告警)的颗粒度小,结构非常固定,主要使用场景是查询,其信息模型和对应的信息交付件模型也相对容易。操作类信息主要用于指导操作,结构化的必要性弱,难度也大,则退而求其次,只要做到半结构化就可以了。信息建模的重点在于定义模块的框架。

第三件,构建数字化信息库。为了保证信息的一致和可靠,结构化数据存储在产品研发流程使用的信息系统中。这就把结构化数据的建设与维护变成了整个研发领域共建共享的数字化信息库。操作类信息等半结构化数据的重点则是信息组件的模块化分解和语义化标注。

第四件,构建自动化流水线。数字化信息库的数据可能存储在多个不同的IT平台上,构建流水线,就是要把多个平台上的数据传送到应用层,把结构化数据、半结构化数据通过接口发布到信息交付件中。在这个过程中,可以利用人工智能和知识图谱技术,增强精准检索、知识推理、智能问答等能力。此外,自动化流水线也可以接入专家知识等非结构化数据。

信息架构师要了解产品研发过程中生成了什么信息,从最初的源头规划和管控产品信息的录入、发布、维护。以硬件信息为例,一块单板,有外观展示,有指示灯和按钮,有功能介绍,有技术指标。根据信息交付件的需要,首先是建模,确定信息内容和期望的样式,然后定义源头数据的承载系统和结构。其中,结构化数据完全由源头数据库承载,非结构化数据则由TW在IDP系统中编写,在编译时再集成在一起。在产品研发流程中,研发工程师负责在源头数据库中录入和维护技术信息,并设置每一个信息的应用条件和发布范围。然后,从源头数据库发布到IDP系统成为Topic,与非结构化数据一起编译成信息交付件。理想情况下,源头数据库同时也是产品代码库的源头,从根本上保证文档与产品的一致性。

这是一次深刻的数字化变革,艰难,旷日持久,但已看见曙光。在数字化变革的过程中,智能化的效果已经初步显现。

***

2023年初,对外经济贸易大学英语学院的董琳老师写论文,想要了解一下华为技术传播的发展历史。在网上查不到什么材料,辗转找我来了解情况。坦率地讲,我虽然在华为十多年,却并不是一个合格的亲历者。真正影响华为技术传播发展历史的关键事件,几乎都没有亲身经历过。

我总是好奇,我们是怎么走出如今这片天地的。

这些年,我听到过一些传闻,知道一些前辈们的事迹,也零星看到过一些侥幸留存下来历史文献,但是很少看见针对这段历史的、真正成文的回顾。董琳老师认为,华为的历史经验太值得分享了;一直往前走,总得有人回顾历史。董老师还认真地建议我从档案研究和口述历史两方面入手做这件事。我这个内向的性格,认识的前辈也不多,做口述历史的访谈实在有点憷。不过,作为一个囤积癖,我确实曾经收集了一些过去的文件,所以不妨做做简单的档案研究。以上就是这个研究的结果。管见所及,一鳞半爪,我不满意,但是我已经尽力了。

如果从第一批员工到编委会算起,2025年将是华为技术传播的第30年。在这30年里,很多人为之奋斗过、彷徨过,很多人相逢在技术传播的工作中,又转战其他工作岗位。有些人留下了姓名,更多的人消失在人海。

如果,我想说,如果你也和我一样,偶尔会怀念那些逝去的岁月,不妨把它写下来。我和很多人一样,相信亲历者的讲述的意义。

 

 

  • 10
    点赞
  • 16
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值