【随笔】我与技术文档这20年
共 5681字，需浏览 12分钟
· 2022-02-09
引子
如果不是那天同事聚餐时滔滔不绝从猪前腿讲到猪后腿，我想我还在纠结岁月跑哪儿去了；如果不是散步时发现必须仰头才能与儿子对视，我想我还在惆怅青春流逝的意义；如果，不是去年（注：2017年）裁员整理简历重新上路，我想我还没意识我与技术文档的故事已经写了20年之厚。
缘起
1997年的夏天，满中国都风迷养电子宠物。同屋女孩周未带我到华强北电子市场瞎逛，憧憬着从电子宠物上掘第一桶金。她当时是环球资源（Global Sources, 彼时叫Asian Sources) 销售助理。也是经由她推荐，我懵懵懂懂地成为了GS旗下《通信科技商情》杂志的助理编辑。
那时软件公司很少，能顺利应聘上一个技术与英文相结合的外企工作，我很知足。没想到，这份工作的选择，让我与技术文档结下了20年的缘份。
杂志是中文月刊，最初的工作是校审英文译稿，字斟句酌删编成文，最后配上个“点石成金”的标题（技能get：翻译校审、中文编辑技巧、面向读者群的文章包装技巧）。98年注定多事，亚洲金融风暴接连着华东水灾，杂志也在重组中更名《国际通信商情》，立足中国通信市场，自主写稿组稿。“有米下锅”的日子转眼变成了要“找米下锅”，每个月被Editorial Calendar追着跑的日子就此拉开了帷幕。
每月领到任务后，第一时间，根据主题上网浏览国外技术文章，锁定技术热点、草拟采访大纲（技能get：快速学习能力）、寻找厂商及业内人士采访（技能get：大胆、执着、沟通技巧），跟踪与确认日期，线上线下采访、催稿（技能get：时间管理）。当一切落定，便是那最后一段段地熬文章（技能get：写作能力）。
每天都是抱着厚厚的技术资料争分夺秒地啃，回家也是带着稿子在身边涂涂改改。煎熬着、努力着，成长着。总主编的赏识、职位的快速晋升给予了我正向回报。
但我发现我并不快乐--2000年初通信杂志的关停，我转到了《国际电子商情》，我对自身的技术实力缺乏底气；加上外企在国内期刊发行上被加上的重重限制，让我觉得在这行做不明不正。我开始思考未来的职业规划，深圳显然不是媒体聚集之地，做回软件开发测试也不现实。那时一位改做Technical Writer的编辑部前辈的经历让我们羡慕不已。
中文用户手册写作--摸索中成长
2000年初，互联网热浪似乎是一夜间席卷了中国，从搜狐新浪到网易携程，IPO上市暴富撩动着大家的心。UTStarcom也在这股浪潮中在美国Nasqad成功上市，编辑部的那位前辈以及第一位被她带到UTStarcom做TW的同事，都因为IPO原始股而一下子身价不菲。
扳指一算，编辑部前后有4位编辑追随这位前辈的足迹，来到UTStarcom深圳研发中心做Technical Writer。前辈南邮学通信出身，是文档组的创始人。我入组时，前辈已经到美国总部工作了。
20年前的文档写作行业，大家都是从模仿与研究竞对手册开始的。随着经验的累积，文档写作理念与方法一步步完善、深化、系统化。从写作规范、样式模板、到内容模板从无到有，各式规范的制定有效地提高了文档组整体写作效率，以及不同产品间文字组织与写作风格的一致性。
深圳文档组最壮大时有十多人，产品线从软交换到3G核心网。中英文TW配比大约3:1，中文TW负责中文手册写作，英文TW负责翻译以及外包翻译文档的校审。文档组成员来自GS编辑部、华为中兴各产品线文档部，团队由内至外散发着专业、敬业、乐于分享、积极向上的士气。团结的队伍在战斗时表现出的是旺盛的战斗力。记得当年的Single source在线帮助项目，Manager一马当先，大家分工合作，在短短一个月内把网管系统需要的Javahelp，运营支撑系统需要的Webhelp技术难点尽数拿下。
Technical Communication是学习知识、传播知识的职业，学习能力与探究心是TW的关键素质。组里TW身上都透着一股刨根问底、你追我赶的钻研精神，为一个技术问题经常是要惊动隔壁格子间的产品经理来给我们讲个透彻。学习新产品，学习产品相关的技术背景知识，让我们与开发测试的交流中保持在同一频道，让文档在术语的撰写、原理的剖析上做到专业、简洁、清晰。这些努力也让我们赢得了研发人员的尊重。
当时，提供文档写作的培训机构基本没有，技术写作也没自己的行业组织，同行间基本没有交流的渠道。大家便商量着开展组内技能分享，每位成员定期分享产品、写作、编辑、绘图、排版技巧。也就是这样，通过英文TW组织的英文写作培训，我知道了Chicago Manual of Style。出于对英文写作的喜爱，事后我打印出了厚厚的中文版，认真阅读英文写作的基本原则。
忙碌、充实、被认可、有回报这大概就是人生不可多得的幸福吧!
英文用户手册--跨过语言的障碍
在CPU处理速度每18个月翻倍的时代，技术演进、市场变化的速度预示着一成不变的工作与生活模式近乎于不存在。通信行业的辉煌来得快、去得也快，短短十年，通信业便从少年走到了暮年。UTStarcom的裁员潮从一开始的隐晦变成了半公开、公开，版本发布的节奏越来越慢，昔日的伙伴挥挥手就此惜别。
现在回头想，从第一轮裁员至我离开的那二三年，人渐渐地滑入了comfort zone。惯性地认为上市公司总有办法，自己低头拉车即好。记得以前看过一篇职场文章：为了防止温水煮青蛙，每三~五年，要到市场上投简历面试，检验一下自己的实力与价值，了解自己与用人市场的差距--回过头来看，是非常值得推荐的做法呀!
我开始思考TW职业道路该怎么走下去，虽然做到了team leader II，可队伍在缩小，向上发展的空间就是零。UT的动荡让我更加急切地想改变。2009年，组里的一位英文TW主动拿裁员包，去一家外资芯片公司英文TW，这让我看到一丝职业发展的曙光。
时至今日，当年UT的战友们，还留在TW行业的，就只有3人了，并且后来都转做英文TW。话说回来，风水轮流转，十年后的今天，用工成本的提高，优惠政策的力度减小，外企在中国市场可谓节节收缩，TW人才又向中文回归。
不过，经过这段时间的找工，真心发现国内企业对年龄的歧视，相较之下，国外企业对年龄反而更加open，更多的是看重你的经验以及与职位的匹配度。
在深圳，知名外企招英文TW的机会很少，这与深圳自身产业发展的特点相关。当看到Moody's招英文TW的广告时，我清楚地意识到这将是我华丽转身的难得机会--那年我35，按事俗的说法，完成职业转换的时间窗就快要合龙了。这必须是一场竭尽全力的争取。
为备战Moody's的电话面试，我联系了儿子的网络外教—一位生活在菲律宾的美国UI设计师，让他为我准备了一套面试题，然后与他一遍遍地演练。机会总是为有准备的人预备的，过五关斩六将，从递简历到最终发offer，历时2个月，长舒一口气，TW的职业道路终于可以进一步拓展!
上班第一天，美国的Manager贴心地把Moody's Style Guide为我准备好，它为我正式打开了英文写作的大门。同时，我将产品有限的几本手册打印出来，这些都是项目从美国迁移至中国之前，由美国本土Writer撰写。通过它们，一则可以熟悉产品知识，两则也为我学习Style Guide的应用提供了范例。
我没有独立写过一本英文文档，虽然我校审过很多修订过不少。平时出于对英文的喜爱，看到翻译稿中的经典表达方式，我会都记录在小本本上。但到写第一本英文手册（Administrator Guide）时，那又是另一回事，那种战战兢兢，至今历历在目。每写一句都想google一下是否地道；为一个冠词的取舍纠结半天。感觉整个人都不会英文了，质疑自己写出来的每一句话。
七年过去了，我也悟出了，写作有时就像说话，要想能写出东西来，你必须做到能自然而然地用这种语言与电脑交谈，也明白了为什么学语言强调听说先行。语言的成长与纯熟绝对与投入的时间成正比，方法、毅力、坚持缺一不可，听说读写需要见缝插针学习的方方面面太多。当一位native speaker面试管问我：How did you learn English to this level? Did you live overseas? 我：It would be a long story if you want to take a listen. 他：It's amazing!
基于在UTStarcom时对手册写作的摸索、研究与实践，我在写作时，很自然地会把自己放在用户的位置，测试产品，揣摩用户的需要，以用户日常任务为手册写作线条。第一份手册写出来，美国manager的评价记得有一句是：内容充实，组织合理。
后来，TechComm大部门邀请加拿大Publish Smarter 公司给全球TW做了一次全面的topic-based writing培训。有了这次系统的理论指导，我对topic-based writing有了全面的认识。但毕竟它只是一次为时6小时的培训，没有提供一份仔细的guidelines，没有提供足够多的案例，让我仔细体会、琢磨与借荐。在实际写作中，我时常遇到种种问题，无法在培训的材料里找到答案。与美国Editor探讨过，与Quora上的同行交流过，让他们推荐了业界优秀文档，但终是有些困惑没有得到解决。
Technical Writer, Sr. Technical Writer, Lead Writer, 一路下去，下一目标将是Principal Technical Writer，如果不是--去年3月Moody's Analytics关停中国CAO产品线，将研发移回美国。
未完待续的故事
有时我会想，如果不是Moody's的突然裁员，我还会是只关注一方山水的辛勤笔耕者，固守着朝九晚五的生活模式，只与同村的邻人互为走往。还在痴想着凭一已之力，苦心琢磨如何把Topic-based writing这个工具使用到极致。
中年失业让我陷入了被动与困惑，但我始终坚信：上天在为你关上一扇窗的同时，一定为你打开了一扇门！
这半年来，一切归零，我从小公司中文文档工程师重新出发。从中文到英文再回到中文，这让我有机会体味与比较这两种语言在表达上的差异，琢磨如何在语言间做到取长补短。
这半年，在分析与学习竞对手册时，让我遇上了华为FusionInsight安装手册，让我对Topic-based writing的应用茅塞顿开。
这半年，我开了简书总结与思考。简书也让我遇见了善于总结与分享的Lilian_Lee，遇上了Developing Quality Technical Information--一本让我欣喜、解开了我心头重重疑惑的写作宝典；更为重要的是，这本书让我强烈意识到内心对技术写作的那份深沉的热爱，让我沉寂的心重新燃起了渴望！
我与技术文档的故事还有没有机会续写，我很努力地争取着。结果不是我单方意愿与努力所能决定的（基于国内企业对年龄的顾虑），但我知道，不努力，就一定没有机会。
栉风沐雨，打击不小，成长不少，我明白只有强大的内心与实力，才能笑对风雨，豁达洒脱。人生是一场修行，从渺小到强大再回归渺小，未来的旅途中，但愿从容平和相随，多思考，勤总结，同时，加强与圈子的交流与学习。
感谢生活中的两位朋友--音乐与跑步！感谢它们的忠实陪伴。带上耳机，逆着风，有节奏地控制着呼吸，我庆幸自己还有跟自己较劲的体力与意志，骄傲自己还拥有充沛的活力，欣喜自己正向着更远的记录迈进......
拍拍身上的尘土，放下一路的包袱，与自已和解，下一程，我们一起轻装前进。
后记：白驹过隙，4年已逝，一路不曾放弃。2019年3月随LG来到南京生活，远程办公。2021年高考首日，在这个有纪念意义的日子，入职CITRIX南京研发中心，任职Sr. Information Developer。感恩，感谢！更要不忘初心，老骥伏枥 志在千里。
Traveling Light
I was doubling over the load on my shoulders was a weight I carried with me everyday
Crossing miles of frustrations and rivers a raging
Picking up stones I found along the way
I staggered and I stumbled down pathways of trouble
I was hauling those souvenirs of misery
And with each step taken my back was breaking
Till I found the one who took it all from me
Down by the riverside (down by the riverside)
I laid my burdens down, now I’m traveling light
My spirit lifted high (I found my freedom now)
I found my freedom now, and I’m traveling light
Through the darkest alleys and loneliest valleys
I was dragging those heavy chains of doubt and fear
Then with the one word spoken the locks were broken
Now he’s leading me to places where there are no tears
我的故事系列