跳转至内容

帮助:编写文章引言

来自 ArchWiki

本文旨在协助 wiki 作者和编辑创建高效的文章,并提升 ArchWiki 读者的阅读体验。

阅读本文不需要了解如何编辑 wiki 页面。本页是一份更通用的风格指南,而非一篇技术编辑指南

文章引言

文章引言(通常)是读者首先接触到的内容,其目的是引导读者进入该主题。

每篇文章的编写都基于一组假设。这些假设对于大多数读者来说并不总是成立的,而文章引言的作用就是筛选出符合作者假设的读者。你并不真的需要向读者介绍文章的其余部分,但它可以帮助澄清某些问题,否则读者即使将整篇文章阅读……很多遍,可能依然无法理解。

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

你需要思考你方法的先决条件,并在开始正文之前呈现这些先决条件。这样做有两个关键好处:

  1. 它允许读者在深入阅读之前,决定是否想要阅读这篇文章。
  2. 它使你能够编写文章而无需过多不必要的离题讨论。

第二点对读者的阅读效率有巨大影响,实际上能使你的文章更加精炼。

在文章引言中,你可以考虑包含许多内容,以下是一些较重要的项(不分先后顺序):

  • 所需的先前经验和知识
  • 系统状态和配置
  • 硬件组件的所有权/拥有情况
  • 读者在本文中找不到的内容

正文内容

我们已经提到了一些可以在文章引言中加入的内容。现在我们将探讨在构建一个高效且有用的文章引言时会遇到的一些问题。

先前的经验与知识

在讨论先前经验时,你需要记住这个词有两种含义。一种是较为宽泛的含义:我们可能会根据一个人的整体知识/经验/名声将其称为“新手”或“大牛”。另一种是参与过某项事件或活动的具体经验(以及由此获得的知识)。出于实用目的,最好在后一种意义上要求先前经验。ArchWiki 上的大多数文章讨论的是特定语境下的具体主题。在给定语境中,“新手”可能表现出精通,而“大牛”可能缺乏兴趣。如果你要求具体的先前经验,读者将更有机会判断自己是否有能力阅读接下来的内容。

你可能还希望为读者提供资源链接,以帮助他们获取理解本文所需的知识。

系统状态与配置

有时,缺少一个软件包或系统组件配置不同,可能会导致文章在某些系统上毫无用处。因此,只要可能,你就需要追踪并定义所有相关的系统配置(例如,相关的 rc.config 参数、必需的软件包等)。

硬件要求

硬件要求通常相当明显。如果你在讨论安装拨号调制解调器 XYZ 的驱动程序,没有人会认为你在讨论调制解调器 ZYX。然而,在某些情况下,提及具体的硬件要求是有好处的。例如,如果你在写一篇关于安装 XYZ-123 驱动的文章,你可以提醒用户,同样的方法可能不适用于 XYZ-456。

此外,添加一张文章即将讨论的硬件照片也是一个很不错的点缀。

读者在本文中找不到的内容

有时,文章的标题可能会产生轻微的误导。因此,你可能需要向读者警告文章的实际主题,并可能提供指向读者原本在寻找的其他文章的链接。

例如,一些读者可能认为本文是关于如何使用 wiki 文本格式化页面的。因此,这些读者得到了警告,告知这不是他们正在寻找的页面,并提供了正确页面的链接。

格式化

文章引言的格式遵循常规的 ArchWiki 惯例。不过,仍有一些细节值得密切关注。

在列出要求时,你有两种方法。一种是用直白的语言详细解释要求和其他引导性说明。另一种方法是提供一个组织良好的要求清单。

© . This site is unofficial and not affiliated with Arch Linux.

Content is available under GNU Free Documentation License 1.3 or later unless otherwise noted.