Plugin API
日本語
日本語
  • 入門
    • 概要
    • あなたの最初のプラグイン
    • ファイル構造概要
    • プラグインタイプ
      • ウィンドウ
      • バックグラウンドサービス
      • フォーマット拡張
      • インスペクター
    • プラグインのデバッグ
  • 配布
    • プラグインの準備
    • プラグインパッケージ
    • プラグインを公開する
    • プラグインを更新する
    • 開発者ポリシー
    • Plugin Icon Teamplate
  • 開発ガイド
    • manifest.json 設定
    • データ取得
    • データ変更
    • ローカルファイルへのアクセス
    • ネットワークリクエストの送信
    • Node.js ネイティブ API の使用
    • サードパーティモジュールの使用
    • 多言語対応(i18n)
    • フレームレスウィンドウ
  • API 参照
    • event(イベント)
    • item(項目)
    • folder(フォルダー)
    • tag(タグ)
    • tagGroup(タグ グループ)
    • library(ライブラリ)
    • window(ウィンドウ)
    • app(アプリケーション)
    • os(オペレーティングシステム)
    • screen(スクリーン)
    • notification(通知)
    • contextMenu(コンテキストメニュー)
    • dialog(ダイアログ)
    • clipboard(クリップボード)
    • drag(ドラッグファイル)
    • shell(シェル)
    • log(ログ)
  • 追加モジュール
    • FFmpeg
GitBook提供
このページ内
  • プラグインの命名
  • プラグインの説明
  • プラグインアイコン
  • プラグインカバー画像
  • レビュースタッフに必要な情報
  1. 配布

プラグインの準備

プラグインを公開する前に読んでおくべきいくつかの提案です。

前へプラグインのデバッグ次へプラグインパッケージ

最終更新 1 年前

プラグインを公開する前に、に準拠していることを確認してください。

プラグインの命名

プラグインの命名は、少なくとも以下の基準を満たす必要があります。

  • 明確な命名 プラグインの名前は、ブラウジング中にユーザーがプラグインの目的をすぐに理解できるように、その主な機能や目的を明確に示す必要があります。たとえば、ブックマークを整理するのに役立つプラグインは、「Bookmark Master」と名付けることができます。これは、「Super Tool」のような曖昧な名前を使用するよりも適切です。

  • 単語数の制限 プラグイン名をシンプルにするために、プラグイン名は30文字または6単語を超えないようにすることをお勧めします。名前が長すぎると、ユーザーを混乱させ、リスト内でのプラグインの表示に影響を与える可能性があります。

  • 動詞ではなく名詞 プラグインの名前は、主に名詞である必要があります。これにより、ユーザーがプラグインの機能をよりよく理解できるようになります。たとえば、「Image Editor」は、「Edit Image」よりもプラグインの名前として適しています。

  • 英語の命名規則 プラグイン名が英語を使用する場合、専門用語でない限り、各単語の先頭文字を大文字にする必要があります。たとえば、「image editor」ではなく、「Image Editor」と書く必要があります。

  • プラグイン名は、 の仕様に従う必要があります

    • ✅ 適切なプラグイン名には、次のものが含まれます。

      • Bulk Image Downloader このプラグイン名は、その機能が画像を一括でダウンロードすることであることを明確に示しています。

      • Duplicate Image Finder この名前は、プラグインの機能が重複する画像を検索することであることを明確に示しています。

      • Image Metadata Editor V2 この名前は、プラグインの機能が画像のメタデータを編集することであり、バージョン2であることを明確に示しています。

    • ❌ 推奨されないプラグイン名には、次のものが含まれます。

      • Extension For Pics この名前は、プラグインに関する機能情報を提供せず、一般的すぎます。

      • Adobe Image Organizer Adobeの承認がない限り、プロプライエタリな名前は使用しないでください。

      • Image#Sorter この名前は、特殊文字#を使用しており、プロセスコードエラーを引き起こす可能性があるか、理解するのが難しいです。


プラグインの説明

プラグインの説明は、少なくとも以下の基準を満たす必要があります。

  • 明確で簡潔な説明 プラグインの説明は、2つの文でその主な機能と目的を明確に説明できる必要があります。たとえば、サムネイル画像ファイルを圧縮するプラグインは、「さまざまな主流の形式の画像をワンクリックで圧縮し、素材スペースを節約します。」と説明できます。不適切な説明は、「Super、awesome tool that makes your design work better.」のようになります。

  • 単語数の制限 説明を簡潔に保つために、プラグインの説明は100文字を超えないようにすることをお勧めします。長い説明は、ユーザーに長くて理解しにくいと感じさせる可能性があります。

  • 適切なキーワードの使用 プラグインの説明は、機能と目的に焦点を当て、プラグインとは関係のない他のキーワードを含めないようにする必要があります。たとえば、プラグインがノートを管理するために使用される場合、説明には、プラグインとは関係のない「game」や「music」のような単語を避ける必要があります。


プラグインアイコン

プラグインアイコンは、少なくとも以下の基準を満たす必要があります。

  • テンプレートデザインの使用 プラグインセンターのスタイルとトーンの一貫性を維持するために、私たちが提供する公式のテンプレートを使用してプラグインアイコンをデザインする必要があります。これにより、プラグインがプラグインセンターの全体的な美的スタイルに一貫していることが保証されます。

  • アイコンの余白 プラグインアイコンの周りには、プラグインセンターリストで認識しやすくするために、一定量の余白が必要です。たとえば、アイコンが青い円である場合、円の端とアイコンの端の間に一定量の空白を残す必要があります。円をアイコン全体で埋めるのではなく、余白を残す必要があります。

  • 高解像度 プラグインセンターに公開されるプラグインアイコンの解像度は、少なくとも256×256ピクセル(px)である必要があり、PNG形式である必要があります。

助けを求める


プラグインカバー画像

カバースクリーンショットは、プラグインセンターリストと詳細ページで表示され、ユーザーはインストール前に提供された機能についてより詳細に理解するためにクリックして閲覧することができます。カバー画像を提供することができ、詳細については説明に詳細を記載することができます。ユーザーがプラグインが提供する機能を理解しやすくし、プラグインの詳細を美しくするために、詳細説明には少なくとも3つの画像を追加することをお勧めします。


レビュースタッフに必要な情報

プラグインにAPIトークンの設定などの追加構成が必要な場合は、READMEファイルを提供して、ルートディレクトリに配置してください。レビュースタッフが参照できるようにしてください。

私たちはあなたのためにアイコンジェネレータを設計しました。から見つけることができます。

アイコンのデザインが得意ではない場合は、に助けを求めてみてください。

Eagle Developer Policies
Apple Style Guide
こちら
コミュニティ
詳細ページの例