当涉及到为Joomla创建扩展——或任何类型的软件——文档始终是该扩展成功的重要组成部分。

良好的文档可以产生

• 更好的用户体验 – 没有人愿意提交支持工单或在论坛上发帖然后等待可能永远都不会到来的答案。当您的客户能够通过阅读手册或观看视频教程找到他们所需的所有信息时，他们会感到非常快乐。

• 更少的支持查询 – 随着问题数量的减少，您将花费更少的时间和金钱在支持上。相反，您将有更多的时间和金钱来添加新功能或创建下一个令人兴奋的扩展。

5种文档类型

在超过五年的Joomla开发中，我了解到当涉及到文档时，不同的客户有不同的需求。有些人喜欢从头到尾阅读手册。其他人喜欢观看视频教程。仅手册是不够的。

我已经确定了扩展需要的5种文档类型。您应该实施尽可能多的类型。

如果您没有时间自己创建所有这些文档，请雇佣某人帮助或请您的忠实客户出力，以换取免费升级或其他补偿。

1. 手册

最基础的文档是手册。有些人会从头到尾阅读它；其他人会将其保留供参考。无论人们如何使用它，手册都应该有良好的组织结构，内容易于查找。

手册应始终包含

• 封面页，包括您的公司名称和标志、网址、扩展名称以及支持、常见问题解答、论坛和升级的链接。
• 目录。
• 简短概述。
• 要求（如有适用）。
• 安装/卸载/升级说明。
• 功能和操作方法。

确保为每个功能包含一个屏幕截图；如果可以展示你所描述的内容，解释起来会更加容易。同时，确保文字大小适中，避免使用浅色文字在深色背景上。创建手册时使用Word文档，完成后转换为PDF格式。

2. 视频教程

视频教程是解释扩展的不同方面和功能的绝佳方式。即使你不是英语母语者（就像我一样），如果你的英语足够好，你仍然可以在视频中讲话。而且不用担心你的声音如何！一开始，视频中的声音总是有点奇怪，但很快你就会习惯。使用诸如Camtasia Studio这样的工具，在解释你的产品如何工作时录制自己。

完成录制后，除了在你的网站上放置视频外，考虑在扩展的后端链接视频教程，因为那里最需要它。你的客户可能不会回到你的网站来观看视频教程，所以让这更容易一些。在iJoomla.com，我们几年前开始在大多数扩展中添加视频教程的链接，我们的客户真的很喜欢。

OS培训最近发布了OSToolBar扩展，它会在Joomla后端显示一个视频按钮。这与iJoomla产品上视频链接的概念相同，但用于通用核心Joomla功能。我相信这是趋势的开始，我希望它将在Joomla社区中成为标准。

3. 工具提示

工具提示是在用户将光标放在元素上时出现在其上方的小“悬停框”。这是教育用户了解页面功能的一种简单方法。

在Joomla扩展中添加工具提示有两种常见方式：

• 添加一个信息图标，在悬停时显示工具提示；
• 将工具提示添加到字段标签（Joomla的默认设置。）

我更喜欢第一种方法。很少用户知道他们可以悬停在字段标签上，他们直到这样做才知道工具提示的存在。图标更清晰。

我采取的一种酷方法是复制字段的描述。这保持了一切的一致性，意味着我不用写两次。我先写手册，描述所有字段，然后告诉我的开发者哪些工具提示放在哪里。

许多开发者误用了工具提示。他们没有提供他们需要的关于描述的元素的信息，而只是重复字段标签。

编写工具提示的正确方法

描述字段的功能，并解释如何使用它。所以如果你要求用户提供API，告诉他们在哪里可以找到它。如果你要求用户上传文件，告诉他们支持的文件类型和最大大小。

编写工具提示的错误方法

重复字段名称。

4. 书面教程

如果你知道你的客户在询问类似的问题，当他们在你论坛或支持系统中提出类似问题时，引导他们到一个包含步骤和图像的教程。这将节省你俩很多时间。这里是我们为iJoomla广告公司创建的书面教程示例，我们还为喜欢视频的人包括了一个视频。

5. 维基百科

维基是一个允许用户协作创建和编辑网页的网站或软件。您可以自己输入内容，也可以让您的客户贡献。

我还没有机会在iJoomla.com上创建维基百科，但我看到其他开发者使用的维基百科都很不错。一个很好的例子是hwdmediashare的维基页面：http://documentation.hwdmediashare.co.uk/wiki/Main_Page

有多个wiki Joomla 扩展可供您使用。我尚未亲自尝试，但 hwdmediashar 使用了一个独立的应用程序：media wiki：http://www.mediawiki.org/wiki/MediaWiki。

技巧

保持您的文档更新 .

如果您对扩展进行了更改，请确保更新您的文档，尤其是如果更改很重要的话。

留到最后。

在开发过程中，您可能会对扩展进行更改——甚至是在最后一刻——因此请将文档工作留到最后，作为发布前的最后一步。

编写好的文档可以节省您的时间和金钱，并让您的客户满意。您还在使用哪些其他文档方法？