谁在拨动时钟？当需要撰写文章时，时间是如何流逝的——而且每次都要接近截止日期。可能那些需要记录他们扩展的人们也是如此。我们通常只是看看演示，阅读简短描述，然后下载并安装它...但是中间缺少了一个步骤；让我们简要看看为什么我们应该阅读文档...

在上一部分中，我们讨论了支持方面，今天我们将查看文档，这些文档可以成为开发者支持的一部分。如果你找到了一个好的开发者，那么你也找到了一个不错的文档！这并不意味着没有文档的扩展就是不好的，但文档通常非常有帮助。

它们如何帮助我们？很简单：安装、配置、故障排除、附加字段、行为等...所有这些都在一个好的文档中描述。

查看文档...

有时“忘记”阅读某人写的100页大书；也许我们不想读那么多，但我们应该...

编写文档的开发者首先是为了展示如何使用他的扩展，它的用途以及如何进行配置。不幸的是，有时文档落后于代码的当前版本，例如，扩展已经更新到3.0版本，但文档仍然停留在2.x版本。这是可以理解的。有时，作为开发者，我们被迫添加错误修复或新功能——但没有时间更新文档。通常版本之间非常相似...

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

在安装方面，这里应该描述的内容相当清晰。对于那些认为安装只需上传和安装软件包就完成的用户来说：错误！有时需要添加、启用其他插件，或者禁用某些插件。或者需要更改服务器配置，或者调整PHP设置……对于简单的扩展来说，这当然不是问题，但如果你在你的页面上安装了真正的J!精华，这可能是必要的。我已经遇到过这样的问题，从那以后就不再使用没有合理文档的扩展。

那么关于“配置”这一章节呢？这取决于扩展提供的功能。一个简单的新闻提示器在配置方面需要的文档会少得多，而一个提供大量附加功能（如新闻通讯、支付网关、自动续订、用户组等）的订阅扩展则需要更多。一本好的手册会详细地描述配置的每个步骤。也许这需要20页来阅读，但这总比头疼要好……即使不需要所有功能，也应该阅读；你可能会发现一些以后可能需要的功能，或者你以前不知道的功能……

关于“修改”的章节取决于扩展本身。有些扩展根本不提供自定义化的可能性（除了模板覆盖）。但如果提供这种可能性，这一章节应该写得能让人们在这里找到帮助。我已经使用了一个订阅扩展构建了一个页面，相应的手册回答了我关于修改的所有问题——我从未需要打扰开发者。

最后——最后——关于“故障排除”。好的文档也会覆盖这里的大部分内容。当然，不可能涵盖所有内容，否则我们根本不需要支持，不是吗？经常出现并且有相同解决方案的问题应该在这里得到解决。如果我们作为用户犯了一个很少发生的错误，我们必须还是得打开一个支持工单……

总的来说，好的文档能帮我们很多忙。开发者是否愿意记录他们的作品是他的决定。我们，作为用户，应该阅读文档，尤其是当开发者不吝时间和精力提供一个好的文档时……你们知道RTFM这个缩写代表什么吗？;-)

本文由Mike Veekmans撰写，并发表在Joomla!社区杂志2013年8月