我们经常收到关于 Joomla 框架 API 完整文档的请求，或者仅仅是关于最常使用的类和方法的文档。虽然在 https://api.joomla.net.cn 有自动生成的材料（我打算在我有时间的时候更新它），但人们真正需要的是关于每个类和方法的实际示例以及有用的提示。现在，只有在过去的六个月左右，API 才足够稳定，让我们可以考虑认真地制作文档，但我相信现在是重新开始这个任务的最佳时机，以更大的热情，并希望有一些新的力量加入。

有 172 个类和可能有一千个方法需要文档化。这是一项繁重的工作，重要的是不要过于雄心勃勃，最后被任务的复杂性所压垮。因此，为了保持简单，我写了一些样本页面，有一个基本的结构，可以轻松地复制到整个 API 中而不需要太多努力。然后，这个框架可以随着时间的推移填充更多细节，示例代码和维基上其他有用材料的引用。

使用维基来保存这份文档的一个原因是，它可以降低参与门槛，让任何人都可以贡献。即使你只写了一个方法的内容，或者甚至只是纠正了一个打字错误，你的贡献也是重要的，非常欢迎。

但实际上，我真正想要触及的是成千上万的开发者，他们每天为自己或客户编写Joomla 1.5的代码。API参考文档对您来说将是无价的，但它需要您的技能和知识来使其真正有用。所以，下次您弄清楚如何使用一个特定的类或者甚至只是一个单一的方法时，为什么不在继续前进之前，成为一个“顺路文档编写者”，对该单项进行一次快速的“大脑倾倒”呢？许多小的贡献可能和少数几个大的贡献一样有效。

无需任何承诺。您不需要加入工作组，也不需要请求许可。只需在维基上注册并开始工作。

要了解更多关于您如何可以贡献，无论大小，到API参考文档，请访问https://docs.joomla.org/API_Reference_Project页面。