ベストプラクティス：アクションカード名と説明

アクションカードに名前と説明を割り当てるときは、推奨されるベストプラクティスに従います。

アクションカードの名前

アクションカードの名前は、新しいフローを最初に保存するときに［Name your Flow（フローの命名）］ダイアログに入力する文字列から派生します。［Name your Flow（フローの命名）］ダイアログは、2つの方法で表示できます。

  • Workflows Designerキャンバスの上部バナーで［Unnamed（名前未設定）］という鉛筆アイコンをクリックします。

  • ［Save（保存）］ボタンをクリックします。

アクションカード名の表記では各単語の最初の文字を大文字にする必要があります。冠詞（定冠詞、不定冠詞）や前置詞などの単語は可能な限り含めません。

たとえば、次のアクションカード名はすべて適切です。

  • Create User

  • Delete File

  • Custom API Action

上記アクションカード名を次のように表記することはお勧めできません。

  • Create a User

  • Delete a File

  • Custom API Action

直感的な命名のために冠詞や前置詞が必要な場合は、小文字で指定します。

  • Add User to Group

  • List Users with Filter

このような例では、「To」や「With」は誤りです。

アクションカードの説明

コネクターのアクションカードをレビューや公開カタログへの掲載のために提出するときは、説明を含める必要があります。説明は、［Name your Flow（フローの命名）］ダイアログで追加できます。

  • カードの説明では、説明に名前や固有名詞が含まれる場合を除き、文章の先頭の文字のみを小文字で表記します。

  • 説明の長さは1、2文に収め、文末はピリオドで終える必要があります。説明には、必要に応じて最大2つの文章を含めることができます。

  • 検索結果を向上させるために、統合されるサービスの名前を説明に含める必要があります（例：OktaSalesforce、Box、Zoomなど）。

  • 説明の文体は現在形とします。

次に、説明の例を示します。

  • Update group details in Google Workspace.（Google Workspaceでグループの詳細を更新する。）

  • Unassign a license from an Azure Active Directory user.（Azure Active Directoryからライセンスを割り当て解除する。）

同じ説明を誤った語調、不適切な大文字化、記号で表記すると次のようになります。

  • Updated group details;（更新されたグループ詳細;）

  • Unassigns a License from a Azure Active Directory User（Azure Active Directoryユーザーからライセンスを割り当て解除する）