软件业务的隐形成本:为什么技术写作技能至关重要
浏览:0
巴克励步
最近和一位 SaaS 创业者聊天,他吐槽说产品帮助中心形同虚设,客服每天重复回答同样的问题,团队被拖得精疲力尽。我翻了翻他们的知识库——内容杂乱、结构混乱,搜索基本靠运气。这让我再次意识到,技术写作不是锦上添花,而是业务运转的隐性命脉。很多企业只盯着功能开发,却忽略了文档成本:员工找信息的时间、客户流失的损失、培训新人的低效。这正是在线帮助中心建设能真正发力之处——用结构化的知识沉淀替代无休止的口头
最近和一位 SaaS 创业者聊天,他吐槽说产品帮助中心形同虚设,客服每天重复回答同样的问题,团队被拖得精疲力尽。我翻了翻他们的知识库——内容杂乱、结构混乱,搜索基本靠运气。这让我再次意识到,技术写作不是锦上添花,而是业务运转的隐性命脉。很多企业只盯着功能开发,却忽略了文档成本:员工找信息的时间、客户流失的损失、培训新人的低效。这正是在线帮助中心建设能真正发力之处——用结构化的知识沉淀替代无休止的口头禅,让内容体验成为生产力的一部分。
在 Stack Overflow 2020 年的开发者调查中,我发现了一个有趣的问题。
近一半的受访者选择了“Hello, old friend”,这表明对于特定任务来说,这种情况可能很常见。
但这是真的吗?还是只是那些想居中
<div> 的人?💛🧡🧡客户评价:Baklib用于组织和管理团队的内外部数字内容,提供多场景的数字体验,以便每个人都可以快速找到他们需要的东西。不再重复问题或挖掘过时的文档。它很简单,而且效果很好。就是这样,简单有效。
引用资源是构建软件业务最被低估的成本之一。那么,既然大多数人可能花数小时研究他们所用技术的优质信息,为什么技术写作和技术文档没有获得更多重视呢?
无论你承认与否,技术文档在工作场所中无处不在。区别在于你记录知识的文化。而这正是技术写作技能发挥作用的地方。
大多数时候,技术写作内容隐藏在私密的 Slack 频道、丢失的邮件以及散落在各种工具或书签中的文档里。
投入时间使产品文档和业务流程广泛可用,对于软件公司至关重要,因为糟糕的文档会让公司付出金钱代价……
……或者,对某些不幸的人来说,可能耗费他们两年的生命:
尽管公司的成本结构取决于其产品、营销和运营,但有几项隐藏成本可以通过加强技术写作技能来解决:
- 员工高流失率:对于开发者来说,不切实际的期望、缺乏文档以及不明确的需求,在 2016 年同一调查的“工作挑战”类别中排名最高。
- 客户不满或销售流失:不满意的客户或潜在客户会选择文档更好的竞争对手。
- 浪费员工时间:员工花在尝试查找信息上的时间本可以用来做更有利润的任务。低效的搜索会因文档编写或组织不当而变得更加困难。
- 高客户服务成本:提供文档站点可能比让人在聊天或工单中回答类似问题更便宜。
为什么技术写手很重要
根据产品和受众的不同,技术写手有各种写作风格。在产品型公司中,技术写手负责文档网站的大部分工作。
记住,尽管技术写手身处一线,但他们并不是唯一产出技术文档的人。
技术文档几乎是每个人职业生涯的一部分。但不要以为谁都能写。通常,写作和编辑工作会交给没有任何正式写作培训甚至基本技能的技术人员。
任何想要在技术写作上做得好的软件公司,都应该有一位全职投入文档工作的技术写手。
这样一来,开发者可以专注于构建酷炫的功能,而技术写手则处理文档。
这并不意味着开发者不必编写文档。显然,开发者对流程细节了解最深,最适合编写特定的集成指南。
与其制作内部文档,技术写手应专注于创建面向用户的文档。技术写手的目标是在不牺牲技术准确性的前提下简化技术内容。
这就是技术写手不仅仅写文档的原因。将硬核技术人员经常使用的信息转化为零技术知识的人也能理解的内容,涉及与关键利益相关者沟通、管理期望,有时甚至要处理尚未存在的信息,或者在会议间奔波以保持步调一致。
当然,并非每家公司都会配备技术写手。这没问题,不是每家公司都需要,但可以肯定的是,每个人都需要在沟通方面变得更好。
你总能变得更好。
变得更好是练习的结果。第一次编写内容可能很有挑战性,但别无他法。
Google 提供了技术写作课程,这说明了为什么技术写手至关重要,以及知识流失如何让软件公司付出比开发者工资更高的成本。
我们记录一切,因为这是必需的。
现在,不要仅仅因为你读到技术写手和文档对软件公司很重要就记录所有内容。
做好尽职调查。分析这是否在耗费你的金钱,或者能否提高组织的效率和生产力。
重要的是避免技术写手、开发者或营销人员对同一件事反复编写,尤其是在推出新功能或产品时。