技术文档工程师采访主题专家(SME)的六步实用指南
浏览:0
巴克励步
我经常看到团队在搭建产品手册时,把精力全花在排版和工具选型上,却忽略了最核心的信息获取——与产品专家的对话。很多产品手册读起来像是开发者的自言自语,就是因为写作者没有掌握采访技巧。其实,一个专业的采访流程能极大提升手册质量。Baklib的产品手册建设功能,支持多人协作和结构化编辑,但再好的工具也需要优质的内容输入。下面分享我梳理的SME采访六步法。 技术文档工程师通常将采访主题专家(SME)列为工作
我经常看到团队在搭建产品手册时,把精力全花在排版和工具选型上,却忽略了最核心的信息获取——与产品专家的对话。很多产品手册读起来像是开发者的自言自语,就是因为写作者没有掌握采访技巧。其实,一个专业的采访流程能极大提升手册质量。Baklib的产品手册建设功能,支持多人协作和结构化编辑,但再好的工具也需要优质的内容输入。下面分享我梳理的SME采访六步法。
技术文档工程师通常将采访主题专家(SME)列为工作中最困难的部分之一。这是有原因的——短短一次对话往往承载着大量信息,要从中提取全部必要内容有时颇具挑战。不过别担心,我为你准备了六条简单且可操作的技巧,帮助你确保获取所需信息,同时让你和受访者都感到愉快。先从有效的目标设定说起。
设定采访目标
在采取任何行动之前,先为采访制定清晰的目标或目的,并与即将面谈的SME分享。这能让对方清楚采访方向,并有机会修改手头资料、做好相应准备。同时也能帮助你掌控采访节奏,避免试图覆盖过多领域而获取低价值信息。你可以从确定要撰写的文档类型开始设定目标。文档形式多种多样,例如:故障排除指南、产品使用说明书、白皮书等。文档类型决定了提问的方向,因为不同类型包含的技术知识层级和呈现方式不同。例如,若撰写故障排除指南,应聚焦用户体验中的问题点;若撰写产品说明书,则需要逐步演示产品功能。确定文档类型后,进一步细化文档的产出目标、目标读者以及你希望从采访中获得什么。以资深技术文档工程师Karen Smock为例,她在准备SME采访时会这样表述目标:“本次采访旨在收集产品X新特性Y的详细信息,用于撰写面向初级用户的白皮书。希望您能概述该特性的核心功能、常见用例及潜在错误场景。” 短短两句话即可让专家明确预期并提前准备。
提前研究主题
SME(如开发者、经理、技术负责人)通常非常忙碌。因此,在采访前做好充分准备是明智之举。资深文档专家Connie Malamed对此表示认同:“无论如何,不要在对主题一无所知的情况下走进SME会议。如果你对内容稍微了解,提问会更专业,也能更深入地挖掘信息。” 这并不意味着你要在一夜之间成为专家,但最好提前阅读相关主题资料,特别是你不熟悉的领域。例如,如果要采访开发产品的API的工程师,不妨先温习API术语,避免在采访中措手不及。这一步骤还可包括查阅公司内部资源,如现有产品文档和内部备忘录。如果你具备编程知识,查看开发人员注释和代码本身也会有所帮助。另一个好方法是亲自试用产品或功能,从最终用户的角度获得体验。这能让你发现产品中不够直观的地方,从而在文档中提供更全面的解释。例如,假设你在记录一款名为Raindrop的书签应用。界面清晰易用,但探索后你可能会希望将现有书签导入应用,然而界面上没有明确的操作路径。这时你可以向SME询问如何导入旧书签,以便新用户不会因此困惑。他们的回答将成为产品文档中一篇专门文章的基础。记住,毫无准备地走进采访,问一些稍加查阅就能回答的问题,肯定会惹恼SME并浪费大家的时间。因此,提前研究,确保你与专家都能有积极体验。
💛🧡🧡客户评价:Baklib正在帮助我们创造可扩展的入职和新员工辅导知识解决方案。因为我们能将决策树、模板、分步操作指南和功能清单集于一身,在内联网知识库上变得越来越容易,因为员工可以自助服务。
提前准备问题
提前准备好问题并在采访前发送给专家至关重要。这样能给他们充分时间准备答案,否则得到的回答可能不准确或过时。既然你已经确定采访目标并做了研究,应该大致知道想问什么,剩下的就是整理思路并以清晰易懂的方式表述问题。以下是一些要点。首先,可以考虑创建一个通用的提问模板,用于每次SME采访,确保覆盖基础信息而不遗漏关键知识。参考Reddit上一位技术文档工程师的常用问题集,它们很好地覆盖了产品的各个方面,并符合用户指南、操作说明或常见问题解答等文档格式。问题包括:使用该功能需要哪些前提条件?请逐步演示操作流程。已知的错误或限制有哪些?完成操作后的预期结果是什么?等等。此外,要注意问题的结构,以获得准确答案。你可以利用认知领域分类法这一小技巧来设计问题。例如,若希望专家逐步展示操作流程,使用“请解释”或“请演示”这类动词,比直接问“这是怎么做的?”能得到更完整准确的回答。最后,避免使用引导性问题(答案已包含在问题中)、双管齐下问题(实际上是两个问题,无法用一个答案回答)和封闭式问题(是或否问题,阻止对方提供完整解释)。这些看似繁琐,但能确保你与SME的会议富有启发性且舒适,从而获得撰写高质量文档所需的信息。
设定合适的氛围
SME采访不应该是冷冰冰的信息提取会议,相反,它最好是一场同行之间的对话。如果你真想从采访中获得最大收益,请努力营造合适的氛围,为轻松的信息共享提供舒适环境。你会惊讶于只要方式得当,即使害羞的SME也能分享大量信息。除了友善和亲和,你还可以采取其他步骤帮助专家放松并畅所欲言。例如,利用你的研究技能,查看公司网页的团队介绍页面,了解对方的专业领域和兴趣。比如,如果发现对方喜欢咖啡,可以带一杯咖啡开始对话;如果对方有摄影爱好,可以以此破冰。如果公司网站没有“认识团队”页面,访问受访者的LinkedIn页面也能起到同样作用。采访开始后,别忘了遵循采访礼仪:专家抽出时间与你交谈,请展示专业礼貌。以下是一些礼貌采访的建议:以欢迎受访者和感谢参与开始;重复采访目标和会议目的,确保双方一致;说明采访预计时长;避免直接命令(如“向我解释...”),而采用礼貌提问(如“您能解释一下...吗?”);结束时表示感谢并请求允许后续联系。通过设定合适的氛围并提供愉快的采访体验,你很有可能获得高质量的信息,同时确保专家乐意参与未来的采访。
录制采访
SME采访的信息量可能非常大。如果你不小心遗漏了重要信息,因为笔记不全而未能写入文档,那就太可惜了。因此,建议在征得同意后录制采访。录制可以让你在采访中更专注于倾听和提问,而不是匆忙记笔记。之后回听录音,你可以捕捉到细节、语气和额外的例子。但请注意,基于合规和隐私考虑,务必在录制前获得明确同意。告知对方录音仅用于你的文档撰写,不会外传。在Baklib中,你可以将录音片段直接关联到文档的相应部分,或者使用AI转录服务将语音转为文字,这些文字可以直接整合进产品手册中。
采访后跟进
采访结束后,工作并未完成。尽快整理录音和笔记,将信息转化为文档草稿。然后,将草稿发送给SME进行核实,确保技术准确性。这个步骤不仅是对专家时间的尊重,还能避免错误在最终文档中传播。在请求审阅时,明确标注你最需要他们重点关注的部分,例如技术细节或流程描述。同时,附上感谢之词,并告知他们何时可以看到最终版本。良好的跟进习惯能巩固你与SME的关系,为未来的合作打下基础。