自从参与 Joomla 以来，我第一次对扩展开发者的 Joomla 文档状态感到兴奋！

过去，Joomla 在开发者文档方面并没有最好的声誉，但对我来说，Joomla 用户手册是一个很大的进步。我认为，对于 Joomla 项目来说，将扩展开发者视为“客户”，并让他们轻松找到 Joomla 中所有的好东西非常重要。

大约一年前，我加入了贡献手册的小团队，看到手册成型非常令人满意。我们还没有到达那里，但绝对是在正确的道路上。

这是为谁准备的？

它主要是为 Joomla 扩展开发者提供的资源。你可以在这里找到它：https://manual.joomla.net.cn/。 

对于那些刚开始学习 Joomla 开发的初学者，有入门页面，其中详细介绍了如何设置开发环境，以及如何联系其他 Joomlers，以及遇到困难时去哪里寻求帮助。

在“构建扩展”部分，我们有一个新的模块教程，它将新手开发者一步一步地引导通过开发 Joomla 扩展的过程，同时在途中介绍一些关键的 Joomla 概念。

对于那些考虑将扩展升级以符合 Joomla 4 中引入的新原则的开发者，General Concepts 部分包含了大量关于命名空间、Web 资产管理器、依赖注入等内容。

对于那些喜欢密切关注未来将带来什么的人来说，迁移部分包含了每个版本的所有新功能和弃用的详细信息。

它有什么特别之处？

简单来说，它的一切都是为了方便开发者。

第一次，我们将在一个地方提供所有开发者文档，并通过左侧的导航窗格轻松导航。通过版本下拉菜单，您可以找到特定版本的文档。

本手册是使用Docusaurus构建的，它不仅具有非常好的展示效果，还能检查一致性——例如，确保没有断链。您可以使用markdown语法编写文档，并使用一些额外的Docusaurus扩展。

我特别喜欢能够在那里上传和存储zip文件的功能。在文档中包含代码部分时，我经常感到沮丧，因为我不知道如何将其融入到整体扩展中。因此，有大量的示例组件、模块和插件可供读者下载和安装，并可以作为实验的基础。

此外，还有一个姊妹GitHub仓库https://github.com/joomla/manual-examples，我们已经开始存储一些示例扩展。例如，有一个“示例表单”组件，它展示了从表单XML文件生成的HTML表单，并显示了提交的原始和过滤/验证后的数据。因此，读者可以使用它作为调查其他Joomla标准表单字段的基础——只需将其插入XML文件即可——以及根据自身需求调整提供的自定义字段、过滤器验证规则。

想要帮忙吗？

尽管手册整体状况相当好，但确实有一些领域需要贡献。到目前为止，很多工作都集中在记录Joomla 4和5的新特性上，因为这是一个需要解决的问题。

现在我们正在将Joomla 3文档的其余部分转换为包括在内。这主要涉及对版本4/5变化的微小修改，以及修改文本以使用markdown语法。

如果您热衷于在“八月披萨、虫子和乐趣”活动中贡献力量，那么为什么不尝试转换现有的文档页面呢。它们大多位于

• Joomla API指南和
• 不同类型插件事件的详细页面

关于如何进行的具体细节请参阅https://github.com/joomla/Manual的README——这是构建Joomla手册的仓库。

我们还非常注重无障碍性。如果您在该领域有专业知识，那么贡献将非常受欢迎！

个人感想

我发现与其他人合作编写手册比我在编写Joomla 3文档时有了更多的团队合作感。我特别感谢Harald的耐心和指导，以及Fedir始终愿意用他的技术专长提供帮助。

结论

我谷歌了“我们正在取得进展”来检查是否有关于这个英语习语的定义，并发现了一个有趣的1980年代英国铁路（GB国家铁路公司）的宣传视频，当时的口号是“我们正在取得进展”。不幸的是，就在这个公司被拆分和部分私有化之后！然而，我相信Joomla手册还有更多的美好未来！