0


0

私は「プラグイン」を使って拡張できるアプリケーションを開発しています。 プラグインはかなり基本的なものになり、開発者は私のアプリケーションに新しい「アクション」を追加することができます。

開発者が必要なことをできるようにするには、どのようなドキュメント/情報を提供する必要がありますか?

私はアプリケーション/プラグインがどのように機能するかの簡単な例と一般的な概要を考えていましたか?

3 Answer


1


あなたは共同体意識を育む必要があります。 ようなもの:

  • 複数の実際のプラグインのサンプルコード。

  • プラグイン作成者のための入門ガイド。

  • プラグインをデプロイする方法と、アプリケーションによってプラグインが検出される方法の詳細。

  • プラグイン作成者が共同作業できるようにするためのWiki

  • プラグインの作者が自分のプラグインを投稿する簡単な方法

役立つかもしれません。


0


また、APIをどの程度詳細にするかを決めなければなりません。 豊富なAPIを提供している場合は、それを適切に文書化し、ディレクティブを明示的に強調表示するようにしてください(明示的な「do」または「don’t do」命令)。

ほとんどのユーザーは、ドキュメントを読んで名前から物事を見つけ出したり、ドキュメントを読み飛ばしたりする必要はありません。 それで、あなたが「それらを驚かせること」を避けることができれば、それが最善であり、そうでなければ、少なくともそれらに問題を見つける機会を提供しなさい。

最後に、あなたの指示を満たしているユーザーを頼りにするのではなく、正しい使用方法をチェックして例外を送信するように注意してください。


0


また、コア製品が「ヒット」するので、誰かが自分のプラグインを使用することを本当に期待しているかどうかを事前に十分に検討してください。

楽観的な見方を誤ることはよくありますが、プラグインインフラストラクチャを作成するときには、誰かが実際にそれを使用すると考えることがよくあります。

しかし、コアとなるすぐに使えるオファリングが成功し普及するまでは、誰もプラグインを作成することはないでしょう。 他の人による拡張について心配する前に、あなた自身のプラグインを公開して配布することをお勧めします。