技术写作中的研究技巧
浏览：1
巴克励步
最近在和做产品手册的团队聊天时，发现一个普遍困扰：大家花大量时间收集信息、采访专家，最后写出来的文档却总感觉差点火候。其实，问题的根源不在写，而在“研”。很多团队把技术写作当成单纯的码字工作，忽略了前期研究的重要性。这正是我一直在思考的——如何通过系统化的研究方法，让产品内容真正服务于用户。Baklib的产品+内容体验解决方案，恰好就是从研究到发布的完整链路，它帮助团队在初期就理清信息架构，避免后期
最近在和做产品手册的团队聊天时，发现一个普遍困扰：大家花大量时间收集信息、采访专家，最后写出来的文档却总感觉差点火候。其实，问题的根源不在写，而在“研”。很多团队把技术写作当成单纯的码字工作，忽略了前期研究的重要性。这正是我一直在思考的——如何通过系统化的研究方法，让产品内容真正服务于用户。Baklib的产品+内容体验解决方案，恰好就是从研究到发布的完整链路，它帮助团队在初期就理清信息架构，避免后期返工。下面这篇文章总结了一些实用的研究技巧，分享给大家。
提出正确的问题
在开始研究时，提出正确的问题至关重要。正确的问题会指导后续的写作并让你紧扣主题，而错误的问题会让你偏离方向，使研究混乱且毫无意义。
技术写作专家对此意见一致。例如，资深行业人士 Kesi Parker 强调了在研究中精心构思问题的重要性：
提出正确的问题时，你就能构建一个强有力的问题陈述。利用你对主题的已有知识来做到这一点。让这些问题作为你的指引，不要低估它们。💛🧡🧡客户评价：选择Baklib的原因： Baklib因其价格和事实上，它提供了具有自定义选项的全面解决方案，无需切换我们的整个支持系统。
你需要提出的问题是那些反映未来文档预期特性的问题。以下是一些启发性示例：
- 谁会阅读我的文档？（受众）
- 需要什么类型的信息？（文档类型）
- 我在哪里可以找到所需的信息？（知识）
- 如何呈现这些信息才能获得最佳用户体验？（格式）
- 最终文档应包含哪些内容？（文档资源）
通过回答至少部分问题，你的研究方法论将开始成形，你将明白如何高效地研究主题。
例如，如果你正在研究产品的连接问题，这些问题的答案可能会引导你得出结论：你应该为 IT 管理员编写一份故障排除指南（文档类型）。
这些答案已经指向你需要聚焦用户遇到的问题而非目标等，并且你将在文档中提供高度技术性的信息。
这些技术信息可以从开发产品的人员或过去解决过此类问题的客户支持团队那里获得（知识）。
最后，通过回答最后两个问题，你可能会决定向上述专家请求分步说明（格式），并创建或查找截图和图表来配合说明（资源）。
这样，回答一组简单的问题就为你提供了寻找所需信息的具体步骤。
研究阶段现在可以真正开始了。
识别可靠来源
在深入研究之前，识别哪些信息源可以安全、放心地使用至关重要，以免向最终用户传递任何不准确或过时的信息。
你的第一个、也是最可靠的信息来源应该是产品本身。
如果你正在研究某个功能以撰写技术文档，那么亲自探索该功能并了解其工作方式是非常合理的。
例如，假设你正在为自动化软件（如 Zapier）编写文档。你的第一步可能是打开应用程序并试用其功能。
通过获得产品的第一手经验，你将能够编写清晰、准确的说明，因为你依赖的是自己的知识。
除了产品之外，你的下一个信息来源是公司的内部资源，这些资源应该高度可靠，因为它们与产品密切相关。
这些资源可以包括开发产品的领域专家（SME），或者任何你可以从中汲取知识的现有内部文档。
前者将在后面讨论。至于后者，可以是开发团队创建的注释和笔记，或是为类似产品创建的技术文档。
这些对你的研究极为有用，但你需要确认它们准确且最新。一个好的方法是确保你拥有文档的最新版本，或者检查文档是否被标记为已验证。
一些文档软件（包括 Baklib）具有让项目干系人将文档标记为已验证和最新状态的功能，这大大降低了使用错误版本的可能性。
所有这些的目的都是确保你始终使用最新、最正确的信息，因为这是确保你的文档对用户有帮助的唯一途径。
在这方面，参与产品的人员、他们产生的信息以及产品本身都是你最可靠的信息来源。
维护资源列表
你可能从上一节推断出识别可靠来源需要付出一些努力，尤其是如果你的公司在产品开发过程中保留了详尽的记录。
可能需要处理大量信息，因此为了节省时间和精力，建立一个文档存档或资源列表是个好主意，这样你可以随时快速获取高质量信息，而无需翻遍公司记录。
例如，假设你的团队正在开发产品的新功能，并为此频繁召开会议。
如果你参加了这些会议，你的笔记可能会成为研究过程中宝贵的资源，因此最好仔细归档以备后用。
如果你的团队在 Microsoft Teams 上进行虚拟会议，你甚至可以录制下来，建立视频录制档案，以便日后获取产品关键信息，这些信息将进入你的文档。
同样，如果有任何你写文档时常参考的在线资源，例如技术写作风格指南或代码参考，最好建立一个书签目录，以便随时访问这些材料。
像 Raindrop 这样的书签管理工具可以帮助你做到这一点。
Raindrop 让你可以将书签整理到集合中，并通过标签和突出显示功能提供导航帮助，让你在几次点击内找到所有内容。
在文档编写过程中，你需要频繁访问大量不同类型的资源。为了让工作更轻松，在研究阶段尽早开始汇编资源列表。
这样，当你坐下来写作时，就能轻松访问你收集到的每一条信息。
咨询领域专家
除了从内部文档和外部资源收集信息外，从开发产品的宝贵团队成员那里也可以获得关键知识。
这些人被称为领域专家（SME），从他们那里提取知识是技术写作的重要组成部分。
作者每天联系和/或会见专家，以获得关于产品问题的答案、跟进信息，以及获取文档的准确性审阅。
作者与 SME 之间的合作形式通常是访谈。在研究期间，作者需要关于产品如何工作的全面信息，因此最好腾出时间坐下来尽可能多地获取产品信息。
做好 SME 访谈的关键是准备。当你咨询 SME 时，应该已经对产品有了一些第一手经验，并且从其他可用资源中获得了一些知识。
技术作者声称，进行访谈的最佳方式是提出开放式问题，并让受访者主导大部分谈话。问题通常围绕产品的基本特性展开。
你可以通过做详细笔记或录制访谈（尤其是虚拟会议）来记录他们的回答。
你的目标应该是一次访谈就获取所有需要的知识，但请记住，后续跟进并请求进一步澄清是完全正常的。
优秀的作者会在坐下来写作之前解决每一个遗留问题。糟糕的作者则因为不好意思再次联系 SME 而选择在文档中发布未经核实的信息。
请记住，领域专家是让你正在记录的产品得以存在的人。因此，他们是关于产品最权威的知识来源，绝对应该在研究阶段进行咨询。
聚焦主题
如果你迄今为止遵循了我们的建议，在研究阶段你应该拥有大量可靠信息和宝贵知识。这很棒，但你应该意识到，信息过多可能会对高质量研究有害。
这是因为做太多研究并陷入细节会浪费大量时间，并让你偏离主题。这不是一种高效的研究方法，所以这里有一些保持专注的建议。
一个想法是采用思维导图的做法。思维导图将你的研究主题置于中心，让你围绕它集思广益所有相关方面。这有助于你识别核心主题，避免被次要细节分散注意力。
另一个建议是设定明确的时间限制。为研究阶段分配特定的时间块，并严格遵守。当时间用完时，转向写作，即使你感觉信息还不完整。你可以随时在写作过程中补充研究。
最后，不断提醒自己文档的最终目的。你的研究是为了支持用户完成任务，而不是炫耀你收集了多少信息。保持这种用户视角会帮助你筛选哪些信息真正重要。
记住，好的研究是为了更好的写作，而不是为了研究本身。
Baklib是一家知识管理软件公司和解决方案提供商。我们不断投资于我们的知识管理系统，因为我们的客户喜欢它！平台使用一年后，客户保留率超过 85%，我们知道我们一定做对了什么。我们相信，在未来，人类、知识和技术的交汇将为世界上任何地方的任何公司的增长和生产力提供动力。只要安全、准确、可靠地应用人工智能，它就能增强工人的智慧，并改变各行各业的业务。随着我们不断增强和完善我们的平台功能和能力，我们的目标是继续成为世界上最好的知识管理软件公司。
