3分钟阅读时间 (630字)

如何选择扩展?第三部分:文档

How to Choose an Extension? Part 3: Documentation

时间过得真快吗?写文章的时候时间总是过得很快,每次都是这样。我想写扩展文档的人可能也是这样。作为用户,我们大多数人只是看看演示、简短描述,然后下载并安装……但让我给你一些为什么我们必须添加阅读文档这一步的理由……

所以上次我们讨论了支持,这次我们来看文档,这可能是开发者提供支持的一部分。如果你找到一个优秀的开发者的扩展,文档是可用的!并不意味着没有文档的扩展不好,但文档可以帮到你很多。

如何?安装、配置、故障排除、额外字段、行为等,在良好的文档中都有描述。

阅读手册……

有时候我们会‘忘记’阅读某人写的100页长的字典……也许我们不想阅读它,但我们应该……

编写文档的开发者主要做这件事是为了真正展示你如何使用扩展,有哪些可能性,如何设置。然而,有时文档并不准确遵循扩展的版本……例如:扩展是第3版,而文档仍在第2版。从我的观点来看,有时由于错误或新功能,开发者需要发布新的扩展,但没有时间重写文档。通常版本非常相似……

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

安装,这里应该描述得很清楚。有些人确信通过管理器安装包就足够了,这是错误的!有时你需要添加、启用或禁用一些插件,更改服务器或php设置的一些小配置……对于基本扩展,你当然不必担心,但当你真的想给你的网站添加一些伟大的J!-juice时,这可能是必需的。我知道我遇到过这个问题,从那以后,我不会使用没有良好文档的任何扩展。

关于配置怎么办?这取决于扩展有哪些功能。一个简单的新闻条将会在配置方面的文档少得多,而那些具有许多额外功能(如时事通讯、支付、自动续费、用户组等)的订阅扩展则会更多。一本好的手册会涵盖配置的每一步,真的每一步。可能这样会增加20页,但比让你拔头发强……即使你不需要所有功能,也请阅读它,你可能会发现你将在不久的将来使用的功能,或者你甚至不知道它存在……

关于定制的部分真的很取决于你选择了哪个扩展,一些扩展无法定制(除了覆盖)。但是,如果你选择了一个可以定制的扩展,这部分应该会对你有很大帮助。当我开发一个订阅模式的网站时,手册给了我关于定制扩展所需知道的一切,我甚至不需要“打扰”开发者。

最后但同样重要的是,故障排除,一本好的文档涵盖了大量的故障排除。不可能涵盖所有,因为那样我们就不会需要任何支持,对吧……?经常发生的问题,并且总是有相同解决方案的项目应该包含在故障排除指南中。如果我们作为用户做了错误的事情,我们仍然需要提交工单,因为这不是一个标准问题……

所以好的文档可以帮我们很多,开发者是否提供它,是他的决定。但我们作为用户,应该阅读它,尤其是如果开发者花了大量时间来编写它……你知道RTFM这个缩写意味着什么吗?;-)

在Joomla社区杂志上发表的一些文章代表了作者在特定主题上的个人观点或经验,可能并不与Joomla项目的官方立场一致

0
新外观模板管理器 - 项目更新
利用争议的力量获得更多流量……
 

评论

已经注册? 在此登录
尚未发表评论。成为第一个发表评论的人

通过接受,您将访问https://magazine.joomla.net.cn/外部提供的第三方服务