帮助:编写文章导言

本文旨在帮助 wiki 作者和编辑创建有效的文章，并扩展 ArchWiki 读者的体验。

您无需知道如何编辑 wiki 页面即可阅读本文。本页面更像是一般样式指南，而不是技术编辑 HOWTO。

文章导言

文章导言（通常）是读者首先遇到的内容，其目的是向他们介绍主题。

每篇文章都以一系列假设开始。这些假设对于大多数读者来说很少成立，而文章导言的目的在于筛选出符合作者假设的读者。您实际上不必向读者介绍文章的其余部分，但它可以帮助澄清一些事情，否则即使阅读完整篇文章，甚至多次阅读后仍然不清楚......很多时候都是如此。

例如，您可能写了一篇关于以某种方式配置系统的文章。但是，您假设读者在其主硬盘上安装了干净且全新安装的 Arch Linux。如果内核被自定义了，例如，您的方法会受到什么影响？或者，如果缺少软件包 X，步骤 3 将如何工作？

您需要考虑您方法的前提条件，并在您开始撰写文章之前呈现这些前提条件。这有两个主要好处

它允许读者在深入阅读之前决定是否要阅读这篇文章。
它使您能够撰写一篇文章，而无需过多不必要的题外话。

第二点对读者体验有巨大的影响，并且实际上使您的文章更加精简。

您可能会考虑在文章导言中包含许多内容，但以下是一些更重要的内容，排名不分先后

所需的先前经验和知识
系统状态和配置
硬件组件的所有权
读者不会在文章中找到的内容

正文

我们已经提到了一些您可能在文章导言中提及的内容。现在，我们将看看制定有效且有用的文章导言中的一些问题。

先前的经验和知识

在谈论先前的经验时，您需要记住这个词的两种含义。一种是更一般的含义。我们可以根据个人的整体知识/经验/声誉称某人为新手或专家。另一种是参与某项事件或活动的具体经验（以及从中获得的知识）。出于实际原因，最好要求后者意义上的先前经验。ArchWiki 上的大多数文章都讨论特定的主题，并且在某些上下文中。在给定的上下文中，新手可能表现出熟练程度，而专家可能表现出缺乏兴趣。如果您要求特定的先前经验，读者更有可能判断他们是否有能力继续阅读文章的其余部分。

您可能还想为读者提供指向资源的链接，这些资源将帮助他们获得理解文章所需的知识。

系统状态和配置

有时，缺少软件包或系统组件配置不同可能会导致文章在某些系统上无法使用。因此，您需要尽可能追踪并定义所有相关的系统配置（例如，相关的 rc.config 参数、所需的软件包等）。

硬件需求

硬件需求通常相当明显。如果您正在谈论安装拨号调制解调器 XYZ 的驱动程序，那么没有人会认为您在谈论调制解调器 ZYX。但是，在某些情况下，最好提及特定的硬件需求。例如，如果您正在撰写一篇关于安装 XYZ-123 驱动程序的文章，您可以警告用户，同样的方法可能不适用于 XYZ-456。

添加您文章讨论的硬件照片也是一个不错的举措。

读者不会在文章中找到的内容

有时，文章的标题可能略有误导性。因此，您可能需要警告读者文章的实际主题，并可能提供指向读者可能正在寻找的其他文章的链接。

例如，一些读者可能认为本文是关于如何使用 wiki 文本格式化页面。因此，这些读者已被警告，这不是他们要找的页面，并且提供了指向正确页面的链接。

格式化

文章导言的格式化遵循通常的 ArchWiki 惯例。但是，仍然有一些细节值得密切关注。

在列出要求时，您有两种方法。一种是用冗长的语言（此处为您的语言）解释要求和其他介绍性说明。另一种方法是提供组织良好的要求列表。