Documentation 插件开发人员需要我的应用程序提供哪些信息？

我正在开发一个可以使用“插件”进行扩展的应用程序。插件将非常基本，允许开发人员向我的应用程序添加新的“操作”

我需要提供哪些文档/信息，以便开发人员可以做他们需要做的事情

---

我在想一个简短的示例和应用程序/插件如何工作的概述？

您需要培养社区意识。例如：

• 多个真实插件的示例代码
• 插件编写者入门指南
• 关于如何部署插件以及应用程序如何发现插件的详细信息
• wiki，以便插件编写者可以进行协作，以及
• 插件作者贡献插件的简单方法

---

可能会有帮助。

您还必须决定API的详细程度。如果您提供的是一个丰富的API，请确保对其进行良好的文档记录，并显式地突出显示指令（显式的“do”或“notdo”指令）

大多数用户不会费心阅读文档，从名称中找出问题，或者浏览文档。因此，如果你能避免“让他们吃惊”，那就最好了，如果不能，至少给他们一个发现问题的机会

---

最后，检查正确的使用并发送异常，而不是指望用户满足您的说明，这是一种谨慎的做法。

此外，请提前考虑是否真的希望有人使用您的插件，因为核心产品已成为“热门产品”

在乐观主义方面犯错误是很常见的，并且认为在编写插件基础结构时，有人会实际使用它

然而，在核心开箱即用产品获得成功和流行之前，没有人可能会编写插件。在担心他人的扩展之前，最好先发布和分发自己的插件