使用Joomla!作为帮助开发工具
在我的第一篇文章中,我提出了Joomla!可能是下一个“杀手级应用”的想法,为专业作家。在这篇文章中,我将Joomla!与商业帮助开发工具进行比较,并希望为作家提供一个有力的理由来切换到Joomla!。我认为Joomla!在帮助开发工具的演变中提供了最好的前进道路。
与商业帮助开发工具一起工作
我们用来创建帮助系统的帮助开发工具在过去10年中变化不大。使用它们,我们可以生成编译的帮助文件,或者“网络帮助”系统,这是HTML文件和JavaScript的集合,在主HTML文件框架内显示或运行。我们可以通过预制的JavaScript库添加动态超链接,如弹出窗口,来让我们的帮助主题更加生动。此外,我们还可以添加图形和视频,创建术语表,并为帮助文本标记索引。
在Joomla!之前的商业软件应用程序中,我使用帮助开发工具,并在开发周期的后期将帮助系统交付给软件开发团队。我通常为厚客户端应用程序提供编译的帮助,开发人员将其捆绑到安装程序中。我为托管、基于Web的应用程序提供网络帮助,开发人员将其放置在Web服务器上的文件夹中。
这个过程多年来一直运行良好。然而,尽管这是一个相当好的系统,但它仍然有一些缺点。例如,我必须适应开发周期的时间框架。虽然代码冻结在理论上是伟大的想法,但我只参与过几个成熟的项目的特性没有被在最后时刻挤进产品中。这通常意味着我在大多数开发周期的最后要工作很多小时才能按时交付帮助(偶尔会出现新特性在最终构建中得到交付但未记录的情况)。
另一个缺点是在最终软件构建后,在帮助中发现错别字或错误,我无法在下一个版本中更正。有时,错误必须长时间未得到纠正。
功能丰富的应用程序编译后的帮助文件大小也引起了问题。在我们从网站向客户推送应用程序的情况下,我们必须确保安装可执行文件尽可能小,因为我们必须考虑到各种连接速度(许多客户的连接速度非常慢)。有几回,我和开发者在编译后的帮助文件大小上争执不下,最后我不得不删除“附加内容”如图形来减小帮助文件的大小。因此,安装程序更小了,但帮助文档的可用性降低了。
最后,但同样重要的是,商业帮助开发工具价格昂贵。市场上只有两家竞争者,竞争如此之少,实际上没有价格战。两家公司都将产品售价定为大约1000美元。但更糟糕的是,其中一家采用了许可模式。当您的许可证到期时,您必须购买新的许可证,否则您的软件将停止工作。
使用Joomla
现在,我将Joomla用作帮助作者工具,我可以向读者提供与静态帮助系统相同或更好(在大多数情况下)的功能。例如,我可以向我文章中添加弹出窗口、图形和视频,还可以创建术语表,并标记文章,这些都是我可以使用静态帮助系统完成的。但在我只能使用帮助作者工具添加基于文本的弹出窗口的地方,我可以通过Joomla的JCE MediaBox插件添加包含文本、图像、视频和其他类型媒体的弹出窗口。我还可以使用Joomla的核心功能执行其他任务,这些任务在静态帮助系统中是不可能的,比如在任何时候为任何文章部署调查,并查看文章使用统计。
我不再需要在软件开发周期内工作,因为我的帮助网站没有与软件捆绑。应用程序和我其中一个Joomla帮助网站之间的唯一联系是帮助按钮,它链接到相应的URL。当开发者在最后时刻或最终构建中添加产品功能时,我可以在整个项目时间表结束之前继续工作。实际上,我可以在产品发布后继续记录功能(尽管这是可能的,但并非最佳过程)。
当我或其他人遇到帮助系统中的程序错误或拼写错误时,我可以立即纠正它们。我不必等到下一个软件版本发布时才进行修正。
我的Joomla帮助网站在自己的服务器上运行,我不再受大小限制的限制。我可以向我帮助文章中添加图形和多种媒体,而不会影响我们应用程序的大小。
最好的是,Joomla是免费的开源软件,我可以免费安装和升级所需的所有实例。我唯一会回到商业帮助开发工具的情况是,如果换工作后无法说服我的新雇主使用Joomla – 但,您可以确信我会尝试。
作者注:这篇文章比我最初计划的要长。我还希望包括一个关于如何在企业环境中创建和部署Joomla帮助网站的描述。我将在未来的文章中尝试涵盖如何使用Joomla作为帮助平台。欢迎对这些建议提出评论。
在Joomla社区杂志上发布的一些文章代表了作者在特定主题上的个人观点或经验,可能不符合Joomla项目的官方立场。
通过接受,您将访问https://magazine.joomla.net.cn/外部提供的第三方服务
评论