技术文档如何体现对企业的价值?

话说技术传播圈儿里有一位与我同名的同行,不过她的英文名是 Emma。这里跟大家分享她的一篇新近好文,有助于深刻理解技术文档对企业的价值。

作者:Emma 李琳;原文出处;已授权转载。

--- 👇 以下是正文 ---

最近有个刚入行不久的技术文档工程师问我:如何说清楚技术文档对企业的价值?

这个问题的潜台词可能是:

  • 我公司领导不重视文档,认为可有可无;
  • 我感觉我的工作没有其他岗位重要;
  • 管理层认为写文档是开发人员的事;
  • 技术文档工程师就跟文员差不多,最多是个好编辑

当然还有一句是:你写了那么多篇文,我就想要一句话概括出来,到底为什么要写文档?

技术文档的价值是分阶段递增的。

下图的阶梯展现了文档价值的递增:从“不得不”的合规阶段,发展到提升产品和企业竞争力的战略阶段。

*来自华为资料部周剑毫的行业会议分享

这个模型最亮眼的可能就是“降成本”,因为跟企业利润有关。除此之外,产品技术文档是否也能成为盈利点?是否还有其他作用?

作为顾问跟很多企业打交道,听到过各种与产品文档有关的问题。这里介绍几个案例,看看最后他们是怎么应对这些问题的。

Q1. 技术文档能给企业带来收入吗?

产品文档是法规要求吗?是的。欧盟、英国、北美或国内,对产品文档有不同的法规要求。例如在欧盟,汽车的使用手册和维修文档,是上市准入的必备条件。在我国,《汽车维修技术信息公开实施管理办法》规定,对于取得 CCC 认证的乘用车和客车,要在车型上市之日起 6 个月内公开维修技术信息。

其他行业有各自的法规要求。产品文档不完善,可能导致严重的法律问题,如果引起人身伤害,面临巨额赔偿,这样的案例屡见不鲜。

产品文档影响服务成本吗?销售规模达到一定水平的时候,服务成本就凸显出来,如何更低成本的提供服务,是成长中的企业迟早会遇到的问题。

服务的组织搭建通常会形成一个阶梯。

第一阶是呼叫中心,客户打电话可以解决一些问题;

第二阶是一线服务工程师,上门服务解决问题。

再升级就是二线或研发,一些更有经验和产品能力的工程师,出马解决问题。

这个阶梯中,成本是逐级递增的。最好第一阶能搞定,这样成本最低。

这里面跟技术文档有什么关系呢?华为有句很有名的口号,叫七远八按,其中的“八按”,是指“按技术文档安装、配置、升级、解决问题.......”。后来提出“三免九自”,有九类服务项目,是用户在技术文档的指导下自服务完成的。这个案例说明,优质的产品文档,对降低服务成本,提高产品的全生命周期成本竞争力,至关重要。

某次我也问过德国行业协会的主席弗瑞兹博士,为什么德国的企业这么重视文档?他很明确的对我说,这是伴随着德国制造走向全球,产生的必然结果,并不是什么文化或思想所致,减成本、增利润才是关键。

产品文档影响市场销售吗?虽然产品文档通常意义上是售后文档,但现在,越来越多的招标活动需要提供全套的产品维护文档。

最近我与一家重工企业交流,他们在海外市场就遇到这样的问题:客户在招标阶段要求提供全套的维修文档,而产品是定制的,按照正常交付流程,只能售后阶段提供,导致投标失利。

为什么招标要看维修文档?产品即服务,或者说全生命周期成本,采购的时候考虑的不仅仅是功能和价格,而是设备的可维护性、可用时间、可靠性这些指标。维修文档、备件清单,是衡量全生命周期成本的证据。

产品文档能单独标价吗?多年前的中兴通讯文档开发部与培训部在同一个大部门下。培训课程卖的很贵,而产品手册并不能卖钱,偶尔出现在报价里,也就是个物料费用,跟合同总额比起来约等于无。

既然不能赚钱,那就给赚钱的部门干点活,争取分一杯羹。于是某阶段,文档开发部也承担了教材开发的职责,正好应用了 DITA 重用机制,把技术文档的内容模块快速组装到教材框架里,一天就可以发布一本新教材,速度比以前快了几倍,一时间皆大欢喜。

第一次见到大额的文档标价,是某个海外网络搬迁项目,产品文档报价 300 万,看看都觉得兴奋啊!这只是个例,但也说明产品文档的确值钱。

Q2. 技术文档工程师重要吗?

好吧,企业迟早会认识到技术文档的价值,那么技术文档工程师呢?

企业要先感知文档需求,再配置对应的资源。这是有时间差的。

很遗憾,这个时间差可能很长。多年前中兴有个国际项目不断遭到文档交付的投诉,面临合同中止的风险,于是 CEO 一声令下,负责研发的副总裁亲自督办,把整个研发部门闭关起来写文档——当时管理层也并没有认可专业文档工程师的作用。

全研发写文档没有解决问题。最后从文档部派遣了一位非常牛的文档架构师,才逐渐改善了答非所问、文不对题的尴尬局面。

我现在做的项目都是一些有志于开拓海外市场的大公司。美嘉林公司在制造企业的服务生命周期管理上,有非常多的实施项目经验,遍布各个行业。从这么多的大公司现状来看,技术文档工程师专业化、技术文档价值最大化,还很任重道远。

有不少企业,已经深切感受到了海外市场的压力,不管是品牌竞争、投标要求还是服务交付,技术文档已成短板。但不是每个企业都会快速建立技术文档部门。

有些只有小规模的文档部门,或者在某个部门内有部分专职的文档工程师。

有些几乎没有专职的文档工程师,只有文员、编辑类的岗位,负责文字审校和版本和存储等。

所以技术文档工程师是否重要?答案是,非常重要。尽管现状不尽如人意,但用高效准确的技术文档,包括各种格式的技术信息,去解决海外市场的各种问题,让中国制造更好、更长久的走向世界,是每一个技术传播人的愿景。

做好准备吧,同行们!

-END-

猜你想读

征稿启事 | 技术传播圈故事征集
什么样的人适合做 Technical Writer?
英语专业的同学可以做技术文档写作吗?
技术文档诞生记 | 完整的技术写作流程是怎样的?
Technical Writer 可提供的交付物有哪些?
免费学习资源推荐 | Google 面向工程师的技术写作课程
Write the Docs:连接技术文档人的全球社区,附海量学习资源
GitHub + Markdown 的新轻型技术写作模式速览
GitHub + Markdown 的技术文档方案深度解析
Technical Writer 日常工作中好用的小工具
技术传播人士应该知道的色彩搭配常识
如何使用颜色来提高技术文档的可读性?
Technical Writer 如何 Review 技术文档?| 重细节+全局观
技术翻译需要有 Technical Writer 的 sense
深度解析关于技术翻译的六个认知误区
如何让你的内容输出更加专业更有设计感?
书单 | 有哪些技术传播从业者必知必看的书籍?
有哪些适合技术传播从业者关注的优质博客?(一)
有哪些适合技术传播从业者关注的优质博客?(二)
行业动态 | 国内有哪些高校开设了技术传播或技术写作课程?
IEEE ProComm 2019 国际传播大会上,中国代表团有哪些精彩分享?
行业动态 | 2019 中国技术传播论坛上,大家都在谈论什么?
优质免费资源推荐 | 9 期技术写作短视频教程带你从入门到进阶
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(上篇)
经验分享 | 来自 11 位 Technical Writer 前辈的职业发展建议(下篇)
Technical Writer 想参与开源项目为文档做贡献,需提前掌握哪些知识?
Technical Writer 如何参与开源项目的文档,以不断提升专业技能?
技术传播沙龙精彩分享 | 高校老师与行业大牛谈“互联网技术写作”
经验分享 | 对用户文档进行伤筋动骨式的重构是怎样一种体验?
英语技术文档的标题到底该大写还是小写?
不同阶段如何应对 Technical Writer 的职业顾虑或烦恼?
如何使用正则表达式批量添加和删除字符?
如何使用正则表达式批量删除多个 Markdown 文件的指定行?
英语技术文档中如何正确使用时态?
英语技术文档中如何正确使用人称?
英语技术文档中如何正确使用无序列表和有序列表?
Markdown:写技术文档、个人博客和读书笔记都很好用的轻量级标记语言
如何为 Markdown 文件自动生成目录?
技术写作实例解析 | 简洁即是美
两分钟趣味解读 Technical Writer
若脱离理解,直译得再正确又有何意?
技术文档翻译实例解析:始于翻译,经于沟通,终于易用
优质译文不应止于正确,还要 Well-Organized
Technical Writer 处理技术文档时,如何避免内容理解问题?
Technical Writer 需要 Technical 到会写代码吗?
如何利用 GitHub Pages 和 Hugo 轻松搭建个人博客?
写在入职技术型创业公司 PingCAP 一个月之后
揭秘 Technical Writer 的工作环境 | 加入 PingCAP 五个月的员工体验记

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,324评论 6 498
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,356评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,328评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,147评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,160评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,115评论 1 296
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,025评论 3 417
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,867评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,307评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,528评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,688评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,409评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,001评论 3 325
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,657评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,811评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,685评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,573评论 2 353