documentation - プラグイン開発者は、私のアプリケーションについてどのような情報を必要としますか?

Question

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

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

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

Answer 1

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

• 複数の実際のプラグインのサンプル コード。
• プラグイン作成者向けの入門ガイド。
• プラグインをデプロイする方法と、プラグインがアプリケーションによって検出される方法の詳細。
• プラグイン作成者が共同作業できる wiki、および
• プラグイン作成者がプラグインを提供する簡単な方法

役立つかもしれません。

Answer 2

また、API をどの程度詳細にするかを決定する必要があります。豊富な API を提供している場合は、それを適切に文書化し、ディレクティブを明示的に強調するようにしてください (明示的な「実行する」または「実行しない」命令)。

ほとんどのユーザーは、わざわざドキュメントを読んで名前から何かを理解したり、ドキュメントをざっと読んだりすることはありません。したがって、「彼らを驚かせる」ことを避けることができれば最善であり、そうでない場合でも、少なくとも問題を見つける機会を提供することができます。

最後に、ユーザーが指示に従っていると期待するのではなく、正しい使用法をチェックして例外を送信することに注意してください。

Answer 3

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

楽観主義の側で過ちを犯し、プラグイン インフラストラクチャを作成しているときに、誰かが実際にそれを使用するだろうと考えるのはよくあることです。

ただし、すぐに使用できるコア製品が成功して普及するまで、誰もプラグインを作成しない可能性があります。他の人による拡張機能について心配する前に、独自のプラグインを公開して配布する方がよい場合があります。