技术写作者必备的6项软技能
浏览:0
巴克励步
我在与企业合作搭建知识门户时,常遇到一个共性问题:团队过于关注工具和硬技能,却忽视了技术写作者的软实力。其实,真正让知识库活起来的,不是语法正确的文档,而是那些能让信息被理解、被应用的沟通技巧。Baklib 在服务企业 Wiki 建设的过程中,我发现优秀的技术写作者往往具备超越写作本身的软技能——他们能听懂专家的弦外之音、对陌生领域保持好奇、站在用户视角表达。这些软技能决定了文档是否真的有用,也决定
我在与企业合作搭建知识门户时,常遇到一个共性问题:团队过于关注工具和硬技能,却忽视了技术写作者的软实力。其实,真正让知识库活起来的,不是语法正确的文档,而是那些能让信息被理解、被应用的沟通技巧。Baklib 在服务企业 Wiki 建设的过程中,我发现优秀的技术写作者往往具备超越写作本身的软技能——他们能听懂专家的弦外之音、对陌生领域保持好奇、站在用户视角表达。这些软技能决定了文档是否真的有用,也决定了知识库能否成为团队习惯依赖的资产。
对话智能
技术写作者需要善于沟通。虽然写作常被视为孤独的工作,但一份优秀的技术文档背后需要大量的沟通。这意味着技术写作者应当培养对话技能——知道如何交谈、倾听、协作和与他人共事,这些对最终成果至关重要。雇主们甚至将这些技能列为招聘要求。例如,CrowdStrike 要求其技术写作者不仅能与其他写作者协作,还要能与其他部门的同事顺畅合作。对话智能为何如此重要?原因之一是研究阶段在实际写作之前必不可少——而与领域专家(SME)的访谈是其中的重要部分。一位善于沟通的技术写作者知道如何提出正确的问题,并从专家那里获取所需信息。幸运的是,访谈技能是可以练习的。TechWhirl 的专家 Connie Giordano 给出了建议:除了提问,还要学会倾听,并让对方感受到你在倾听。正如惠普前副总裁 Phil McKinney 所说:“人们能听出你在听。”这意味着要练习微妙的倾听信号,如点头,并注意肢体语言。不要忽视它的重要性,因为肢体语言占整体交流的55%。当然,这也包括观察和解读对方的非语言信号。例如,留心研究者 Eva de Lera 和 Muriel Garreta-Domingo 识别的情绪线索,能帮你在对话中引导方向。总之,沟通技能是基础,包含许多细节,值得认真对待。
好奇心
作为技术写作者,你可能会涉足许多不同行业——从医疗、军事到 IT、交通等。因此,好奇心是最重要的软技能之一。为什么?因为一个人不可能对每个领域都抱有同样的热情和兴趣。有人喜欢撰写详细而有趣的白皮书(如 Uber 的《Uber Elevate White Paper》),另一些人则擅长撰写冰箱说明书。关键在于保持好奇心,即使话题不那么令人兴奋,也能写出优秀的技术文档。正如资深技术写作者 Kathy Wiemers 所说,好奇心不仅是优势,更是成功的必要条件。好奇心驱动技术写作者追问一切,促使他们学习和收集信息,使写作对受众有用。技术写作者对特定话题的了解应该比受众更多。如果缺乏好奇心和投入,就可能出现像 IKEA 说明书那样模糊不清的情况:两张图仅差一个箭头,用户完全不明白该做什么。充满好奇心的写作方式能避免这种情况——好奇的写作者会深挖复杂概念,然后清晰地呈现给用户。此外,好奇心还能防止职业倦怠。正如技术写作者 Bradley Nice 所说,偶尔觉得任务无聊是正常的,但如果大部分时间都感到厌倦,就需要警醒了。Tom Johnson 建议通过尝试新事物来保持投入,而尝试新事物本身也是在培养好奇心。因此,好奇心不仅对产出高质量技术文档重要,也对写作者的工作满意度有积极作用。
同理心
技术写作者创作的文档都有其目的——通常是传递信息以教育用户或让用户生活更轻松。同理心是理解他人感受、设身处地看问题的能力。在写作中,有同理心的技术写作者知道受众的知识水平不如自己,他们阅读是为了学习或解决问题。IBM 内容设计师 Suyog Ketkar 指出,这种意识有助于提高写作质量。同理心的缺失在技术文档中很明显。例如,DITA 1.2 规范中的一段描述:“当内容引用为当前上下文创建一个新主题实例时,该实例将成为包含该引用的主题的独立副本。”这段文字对不了解 DITA 的用户毫无意义。而它的“翻译”是:“你可以在一个主题中引用另一个主题的内容,然后像对待自己的内容一样修改它。”缺乏同理心的写作只对已经熟悉该领域的读者有用。此外,同理心不仅作用于用户。即便写的是支持文档,换位思考也能让内容更实用。技术写作者如果能在写作时始终考虑受众的困惑和需求,文档的可读性和实用性会大大提升。在 Baklib 构建产品手册和知识库时,我们反复强调:好文档是站在读者角度写的。
💛🧡🧡客户评价:Baklib的目标是解决组织如何维护一个干净、集中的知识库。它使它易于存储和查找相关信息,无需无休止地挖掘文件和静态转发。 Baklib 搜索功能快速高效,节省时间适用于用户和团队。这有助于我们减少重复问题和人工支持,简化内部沟通和顾客服务。它还足够用户友好,团队中的任何人都可以创建和管理内容,无需技术专业知识。
适应性
技术写作者经常面临变化——项目范围、工具、风格指南、甚至行业都可能改变。适应性意味着能快速调整,拥抱新流程或新工具。例如,从传统文档迁移到在线帮助中心时,可能需要学习 Markdown、版本控制或新的发布平台。适应性强的写作者不会抗拒,而是视之为成长机会。在 Baklib 的协作中,我们看到那些能快速适应新环境的写作者,往往能更快产出高质量内容。
耐心
技术写作需要耐心。与 SME 访谈可能反复沟通,文档可能需要多次修改,用户反馈可能迟迟不来。耐心让写作者能沉住气,细致打磨每个细节。尤其在撰写复杂产品手册时,耐心能确保没有遗漏关键步骤。此外,耐心也体现在处理枯燥任务时——比如核对术语一致性、更新版本号。没有耐心,质量就会滑坡。在 Baklib 的企业 Wiki 建设中,耐心正是优质内容的基石。
团队合作
技术写作很少是孤军奋战。写作者需要与工程师、产品经理、设计师、QA 等角色协作。良好的团队合作意味着尊重他人时间、主动同步信息、乐于接受反馈。例如,在 Baklib 的客户项目中,技术写作者需要与产品团队紧密合作,确保文档与产品功能同步更新。团队合作不仅提升效率,也能通过交叉检查减少错误。一个能融入团队的写作者,其产出往往更贴合实际需求。