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

Question

我正在开发一个可以使用“插件”扩展的应用程序。这些插件非常基础，允许开发人员为我的应用程序添加新的“操作”。

我需要提供哪些文档/信息才能使开发人员能够做到他们需要的工作？

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

Answer 1

你需要培养一种社区感。比如：

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

可能有帮助。

Answer 2

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

大多数用户都不会费心阅读文档并从名称中找出内容或浏览文档。所以最好是你可以避免“让他们感到惊讶”，如果没有，至少让他们有机会找到问题。

最后，谨慎一点，检查正确使用并发送例外，而不是指望用户符合您的指示。

Answer 3

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

在乐观方面犯错是很常见的，并且认为当你编写插件基础设施时，有人会真正使用它。

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