3分钟阅读时间 (630字)

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

How to Choose an Extension? Part 3: Documentation

已经是时候了吗?当你写作文章时,时间飞逝,每次都接近截止日期。我想写文档的人也是这样。我们大多数人作为用户,只是看看演示,简短的描述,然后下载并安装...但是让我给你一些为什么我们必须添加阅读文档这一步骤的原因...

所以上一次,我们有支持,这次我们来看看文档,这可以是开发者提供支持的组成部分。如果你找到一个来自优秀开发者的扩展,那么文档是可用的!并不代表没有文档的扩展就不好,但文档可以帮助你很多。

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

阅读手册...

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

编写文档的开发者主要做这件事是为了真正向你展示如何使用扩展,有哪些可能性,如何设置它。然而,有时文档并不严格遵循扩展的版本...

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

安装,这里应该描述的内容已经很清晰了。那些认为只要通过管理器安装包就足够了的人,大错特错了!有时候,你可能需要添加、启用或禁用一些插件,更改服务器或PHP设置……对于基本扩展,你当然不需要担心,但当你真正给网站添加一些精彩的J!-juice时,这可能就是必要的。我知道我曾经遇到过这个问题,从那以后我不再使用任何没有良好文档的扩展。

关于配置呢?这取决于扩展具备哪些功能。一个简单的新闻条目可能关于配置的文档要少得多,而一个具有许多额外功能(如新闻通讯、支付、自动续费、用户组等)的订阅扩展则会有更多的配置文档。一个好的手册会涵盖配置的每个步骤,真的是每个步骤。可能因此增加了20页,但比让你抓狂要好……即使你不使用所有功能,也请阅读它,你可能会发现你将来会用到的功能,或者你甚至不知道它存在……

关于定制的部分,很大程度上取决于你选择的扩展,有些扩展无法进行定制(除了覆盖)。但如果你选择了一个可以进行定制的扩展,这部分应该会对你有很大帮助。当我开发一个订阅模式的网站时,手册给了我关于如何定制扩展的所有必要信息,我无需“打扰”开发者。

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

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

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

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

评论

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

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