3. 审阅现有文档

本项目将专注于审阅 LDP 中已有的文档。我们的目标是实施一个质量管理程序,以确保我们提供最新、准确、易于阅读的文档。这个过程将在 LDP 的整个生命周期中持续进行。最初,我们将尝试审阅 LDP 上当前的所有文档。一旦我们完成了对现有文档的审阅,我们将安排后续审阅的日期。通过在文档在 LDP 的整个生命周期中不断进行审阅,我们帮助确保读者获得 Linux 文档的最佳体验。

除了改进文档质量本身这一主要目标之外,我们还将收集有关文档集的数据,以便存储在某种数据库中,从而促进对文档集的持续管理。然而,审查的这个阶段仍在定义中;关于具体细节以及如何衡量这些数据的信息将在未来添加。

以下是一些在您开始为 LDP 审阅现有文档之前应遵循的通用指南。请尽量在您注册审阅文档后的两周内完成文档审阅。

3.1. 选择文档

有很多文档需要审阅。最重要的是您与其他审阅者协调您的工作。为了协调工作,我们为审阅者设立了一个邮件列表。

在您开始审阅文档之前,请通知编辑列表(订阅说明位于 http://www.tldp.org/mailinfo.html#maillists)。我们希望确保您的工作被引导到最需要和最有用的地方。当然,您可能在特定领域具有专长,这将在一定程度上决定您的选择。您可以在列表中询问分配任务,或者您可以自己选择一个,只需让邮件列表知道您正在做什么。

3.2. 许可问题

确保您拥有处理该文档的合法权利。如果它是在明确授予此类权利的自由许可下许可的,则您没问题。否则,您需要联系作者并获得许可。

如果您不打算实际更改任何内容,而只是报告文档的状态,那么无论许可如何,您都不需要获得许可。当然,给作者写信仍然是礼貌且明智的做法。

如果文档缺少版权和/或许可,建议您建议作者选择并应用一个。有关许可的更多信息,请参见第 7 节

3.3. 使用最新版本

确保您正在审阅的副本是最新的。

如果您的文档包含指向官方主页的 URL,请访问该页面并查看它是否显示相同的版本号。如果您找到相同的版本号,则您没问题。如果您找到较新的版本号,请写信给作者,请他或她向您提交较新的版本。

3.4. 选择要进行的审阅类型

文档可以通过许多不同的方式进行审阅,您可能只具备执行一种或两种类型审阅的技能。有时将每种审阅作为单独的文档遍历来完成是有用(且更容易)的;效果可能因人而异。

以下部分解释了我们正在进行的各种审阅类型。使用这些部分作为指南,以帮助您选择要进行的审阅类型,并帮助您进行审阅本身。再次强调,当您将您的审阅选择发布到审阅列表时,请指定您希望负责的审阅类型。