3.2. 文档范围

现在您已经确定了主题，您需要决定文档的范围。范围或主题领域应该：

1. 清晰定义。 在开始之前，明确您主题领域的边界。不要重复另一个 HOWTO 中的信息，也不要在您的 HOWTO 和其他人的 HOWTO 之间留下信息空白。

2. 不要太宽泛，也不要太狭窄。 如果您尝试涵盖过多的信息，可能会牺牲深度。最好详细地涵盖一个较小的主题领域，而不是粗略地涵盖一个大的主题领域。Linux 工具以只做一件事并把这件事做得好而闻名。同样，您的 HOWTO 应该涵盖一个主题并将其做得好。

   如果您的拟议文档范围非常狭窄，最好将您的信息作为另一个 HOWTO 的一部分包含进来。这使得读者更容易找到他们需要的 HOWTO。在 LDP 存储库中搜索与您的文档相关的主题。如果您找到一个非常匹配的文档，请给作者发送电子邮件，询问他们是否愿意包含您的贡献。

3. 未被文档记录。 在记录特定主题之前，请务必进行网络搜索（特别是搜索 LDP 文档），查看您的主题是否已在另一个文档中涵盖。如果是，请参考另一个文档，而不是在您自己的文档中重复信息。您可能希望包含可在其他文档中找到的信息的简短摘要。

   如果现有的 HOWTO 不足或需要更新，请联系作者并提供帮助。另请参阅 第 3.3 节，了解如何接管旧的或无人维护的文档。

   大多数作者都感谢提供的任何帮助。此外，向作者发送评论和意见通常被认为是安慰和奖励：对于作者来说，反馈是证明编写文档并非徒劳的最终证据。

4. 经 LDP 预先批准。 在您继续编写 HOWTO 之前，请发布到讨论列表并从其他 LDP 志愿者那里获得一些反馈。在您开始之前与列表核对可以为您以后省去麻烦。

	保持联系！
	加入讨论列表并定期关注它，即使您从不发帖，也是了解 LDP 的活动、需求和政策的好方法。

3.2.1. 文档模板

在您确定文档范围之后，您应该开始考虑您将编写的文档类型。有许多不同的 LDP 文档模板：指南（Guides）、HOWTO、man pages 和 FAQ。Rahul Sundaram 在 Linux 文档项目 (LDP) FAQ 中描述了它们的范围。这里简要概述了它们是什么，并提供关于如何开始编写您自己的文档的指导

• 指南（Guides）。 指南涵盖广泛的主题，并且篇幅较长。《作者指南》（本文档）就是一个指南。其他指南包括：Linux 入门：实践指南、Linux 内核模块编程指南 等。完整的指南列表可在以下网址获得：Linux 项目文档指南。指南使用位于 附录 A 中的 “book” 模板。

• HOWTO。 HOWTO 通常是一组逐步说明如何完成特定任务的指南。HOWTO 的示例包括：CDROM-HOWTO Module-HOWTO。完整的 HOWTO 列表可在以下网址获得：HOWTO 列表（警告：页面很大）。HOWTO 通常使用 “article” 模板，默认情况下输出到多个 HTML 页面。模板位于 附录 A 中。

• man pages。 man（Manual）页面是许多 Linux 应用程序和实用程序的标准帮助形式。可以通过在提示符下键入 man 应用程序名称 来查看它们。完整的 man pages 列表可在以下网址获得：Linux Man Pages。由于 man pages 与软件捆绑在一起，因此目前没有 LDP 模板。

• FAQ。 FAQ（Frequently Asked Questions，常见问题解答）是问题和答案的列表，旨在帮助防止新用户一遍又一遍地问相同的问题。完整的 FAQ 列表可在以下网址获得：Linux 文档项目 FAQ。FAQ 通常使用 “article” 模板，并使用一些特定的 DocBook 元素来形成问答结构。您可以在 附录 A 中找到用于编写 FAQ 的模板。

	mini-HOWTO 和 HOWTO
	LDP 不再区分 HOWTO 和 mini-HOWTO。所有以前编写的 mini-HOWTO 都已包含在较长的 HOWTO 中。所有新文档的长度必须至少达到 HOWTO 的长度。这意味着文档应该涵盖更大的主题领域，而不是小的主题领域。如果您的文档非常小，您可能希望将其提交以包含在另一个现有的、更大的 HOWTO 中。如果您不确定文档的大小，请发送电子邮件给讨论列表并征求反馈。