是不是已经是时候了？……我想，对那些编写扩展文档的人来说也是一样。我们大多数人作为用户，只是简单地看看演示、简短描述，然后下载并安装……
但是，让我给你一些我们应该查看文档的理由。

注意：本文是Mike Veeckmans撰写的文章How to Choose an Extension? Part 3: Documentation的翻译。

在上一篇文章中，我们谈到了支持，这一次，我们将看看文档，它可能是开发者提供的支持的一部分。如果你发现了一个由优秀开发者提供的扩展，那么文档将会可用！这并不意味着没有文档的扩展就是低质量的，但文档确实可以真正帮助你。

如何？安装、配置、故障排除、附加字段、行为等都在良好的文档中描述。

阅读手册...

有时我们“忘记”阅读某人写的100多页长的字典……也许我们不想读，但我们应该……

编写文档的开发者主要是为了向您展示如何精确地使用扩展，有哪些可能性，如何进行设置。然而，有时文档并未跟上扩展的不同版本...比如：扩展是第3版，而文档仍在第2版。在我看来，难以理解的是，有时开发者可能因为bug等原因需要发布新版本，但没有时间重写文档。而版本之间非常相似...

一个好的文档至少应该包含四个部分。安装、配置、自定义和故障排除。

安装，本部分所解释的内容必须清晰。对于那些认为只需通过管理器安装包就足够了的人来说，这是错误的！有时，您可能需要添加、启用或禁用某些插件，更改服务器或PHP设置上的小配置...对于基本扩展，当然不必担心，但当您添加大量扩展时，您必须注意。我知道我在说什么，我曾经遇到过这个问题，从那以后，我从不使用没有良好文档的扩展。

关于配置？这取决于扩展提供的功能。一个简单的新闻展示器可能需要比具有许多功能的订阅管理扩展（如新闻简报、支付方式、自动续订、用户组等）更少的文档。一个好的手册将涵盖配置的每个步骤，确实是每个步骤。也许这将使文档增加到20多页，但最好还是多读一点，而不是头发都抓破了。即使您不会使用所有功能，也请阅读文档，您可能会发现一个您之前不知道的功能，以后可能会用到。

关于自定义的部分，这完全取决于扩展本身，有些扩展（除了使用覆盖）无法自定义。但如果您选择了一个可以进行自定义的扩展，这部分可能会对您非常有用。当我开发一个包含订阅功能的网站时，手册为我提供了有关扩展自定义所需的所有知识，我无需“打扰”开发者。

最后，但同样重要的是，良好的文档涵盖了用户可能遇到的大量问题。不可能涵盖所有问题，因为那样我们就不再需要支持了，对吧？最常见的、通常有相同解决方案的问题应该列在这个文档中。如果我们作为用户犯错，不一定需要创建工单，因为这不是一个标准问题...

因此，良好的文档可以大有帮助，如果开发者提供了它，这是他的决定。但作为用户，我们必须阅读它，肯定是因为开发者花费了大量时间来编写...
你知道RTFM这个缩写是什么意思吧；)