documentation - 插件开发人员需要我的应用程序的哪些信息？

Question

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

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

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

Answer 1

你需要培养一种社区意识。像：

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

可能有帮助。

Answer 2

您还必须决定 API 的详细程度。如果您要提供丰富的 API，请确保对其进行良好的记录，并明确突出显示指令（明确的“做”或“不做”指令）。

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

最后，在检查正确使用和发送异常时要小心谨慎，而不是指望用户满足您的指示。

Answer 3

另外，请提前考虑好您是否真的希望任何人使用您的插件，因为核心产品会成为“热门产品”。

乐观地犯错是很常见的，并认为当您编写插件基础设施时，有人会实际使用它。

但是，在开箱即用的核心产品成功并流行之前，没有人可能编写插件。在担心其他人的扩展之前，您最好发布和分发自己的插件。