关于编写项目文档的 5 个自问问题

在开始实际编写文档的环节之前，甚至在采访专家之前，最好先回答一些关于您的新文档的高级问题。

著名的传播理论家哈罗德·拉斯韦尔在他 1948 年的文章《社会传播的结构与功能》中写道

描述传播行为的一个便捷方法是回答以下问题

• 谁
• 说了什么
• 通过哪个渠道
• 对谁说
• 有什么效果？

作为一名技术传播者，您可以应用拉斯韦尔的理论，并回答关于您的文档的类似问题，以便更好地传达您的信息并达到预期的效果。

谁——文档的所有者是谁？

或者，文档背后的公司是哪家？它想向受众传达什么样的品牌形象？这个问题的答案将极大地影响您的写作风格。公司可能也有自己的风格指南，或者至少有一份正式的使命声明，在这种情况下，您应该从那里开始。

如果公司刚刚起步，您可以向文档的所有者提出上述问题。作为作者，将您为公司创造的声音和角色与您自己的世界观和信仰相结合非常重要。这将使您的写作听起来更自然，更不像公司术语。

说了什么——文档类型是什么？

您需要传达什么信息？文档类型是什么：用户指南、API 参考、发行说明等？许多文档类型都有模板或普遍认可的结构，这将为您提供一个起点，并帮助确保您包含所有必要的信息。

通过哪个渠道——文档的格式是什么？

对于技术文档，传播渠道通常会告知您文档的最终格式，即，它是 PDF、HTML 还是文本文件等。这很可能也决定了您应该使用哪些工具来编写文档。

对谁说——目标受众是谁？

谁将阅读这份文档？他们的知识水平如何？他们的工作职责和主要挑战是什么？这些问题将帮助您确定应该涵盖哪些内容，是否应该深入细节，是否可以使用任何特定术语等。在某些情况下，这些问题的答案甚至会影响您应该使用的语法的复杂程度。

有什么效果——文档的目的是什么？

在这里，您应该定义这份文档预期为潜在读者解决什么问题，或者它应该为他们回答什么问题。例如，您的文档的目的是教您的客户如何使用您的产品。

在这一点上，您可以参考 Divio 建议的方法。根据这种方法，您可以根据文档的总体方向将任何文档分配为四种类型之一：学习、解决问题、理解或获取信息。

在这个阶段要问的另一个好问题是，这份文档旨在解决什么业务问题（例如，如何降低支持成本）。考虑到业务问题，您可能会看到写作的一个重要角度。

结论

以上问题旨在帮助您形成有效沟通的基础，并确保您的文档涵盖所有应涵盖的内容。您可以将它们分解为您自己的问题清单，并在您需要创建文档时随时使用它们。当您遇到困难，面对空白页时，此清单也可能会派上用场。它有望激发您的灵感并帮助您产生想法。