终端用户文档对于任何 Joomla! 扩展的成功至关重要。在 Joomla! 扩展目录中最受欢迎和最受欢迎的扩展都有详细的文档。

终端用户文档

文档可以采用在线文档、PDF、视频教程和印刷手册的形式。它应该涵盖您扩展中的每个功能。高质量的文档需要反映扩展当前版本的实际情况。理想情况下，它应该是交叉引用和可搜索的。不出所料，大量 Joomla! 开发者使用 Joomla! 创建他们的文档。

其他帮助创作工具的评估
Google 文档工具目录

无论您选择哪种软件来帮助您创建文档，涉及的过程总是相同的。

确定您的受众

这并不像听起来那么简单。可能会有普通用户、更有经验的设计师、知识渊博的开发者甚至系统管理员。您可能假设您的大部分读者在尝试您的产品之前不会阅读文档。大多数人只有在遇到意外情况并需要指导时才会转向文档。一本用户指南可能无法满足您整个受众的需求。

---

概述您的文档

在没有计划的情况下开始是没有意义的。您在没有计划的情况下开始编程吗？可能不是。以下是一个示例大纲。

1. 简介
2. 免责声明、版本和许可协议
3. 目录
4. 指南正文
   • 安装
   • 升级
   • 卸载
   • 分步指南
5. 参考资料、术语表和额外要求
6. 联系和支持信息
7. 版权和归属

1. 简介

简要说明扩展的目的。说明它将做什么和不会做什么。

2. 免责声明

明确表示您不对用户网站承担责任，也不提出任何保修声明。
说明您产品的当前版本。
明确说明您的许可协议，并链接到相应的资源。

3. 目录

在编写并完成指南后添加此内容。随着您文档的每一次更新，您的内容表也需要更新。

4. 指南正文

每个项目的具体内容可能有所不同，以下是一些需要涵盖的要点

• 安装（包括自动和手动安装）
• 卸载（包括自动和手动卸载）
• 升级过程
• 解释您扩展中每个菜单/选项的含义
• 分步指南
  视频截图对此非常有帮助。如果您不喜欢自己的声音，可以尝试使用Captivate等程序。只要不跳过步骤，静态屏幕截图也效果不错。
• 困难点（用户可能偏离轨道的地方）

5. 参考材料

解释您文档中可能使用的任何技术术语。包括链接到有用的网站。
例如，如果您引用了正则表达式（RegEx），则解释正则表达式是什么，并提供到https://regexper.cn的链接。如果您引用了文件权限，花点时间解释如何在您喜欢的FTP程序中更改它们。

6. 联系方式和额外支持信息

如果您有论坛，请链接到它们。如果您有基于订阅的支持，请链接到您的订阅选项。如果您不计划在文档之外提供任何支持，请明确说明。Joomla! 由志愿者提供支持，并非所有第三方开发者都能提供支持。

7. 版权和归属

如果您尚未这样做，请声明您对产品和其支持文档的版权。明确说明您与Joomla!项目的关系，或没有关系。

---

为您的指南创建一致的风格

决定如何格式化代码。也许您会将可点击的项目加粗。也许您的部分标题总是H2标签。您风格的细节取决于您。重要的是在整个文档中保持一致。因此，创建您自己的风格并坚持下去！

---

开始记录！

不要一次承担整个项目。将其分解成更小的部分，并使其成为正在进行的工作。大多数文档都是“正在进行”的。