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

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

アクションカードの名前

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

• Workflows Designerキャンバスの上部バナーでUnnamedという鉛筆アイコンをクリックします。

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

アクションカードの名前はタイトルケースで指定する必要があります。各単語の最初の文字は大文字にします。冠詞（定冠詞、不定冠詞）や前置詞などの単語は可能な限り含めないようにします。

たとえば、アクションカードの適切な名前は次のようになります：

• ユーザーを作成する

• Delete File

• カスタムAPIアクション

上述のアクションカード名の次のバージョンはお勧めできません。

• Create a User

• Delete a File

• custom api action

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

• ユーザーをグループに追加する

• List Users with Filter

これらの例でも、「To」や「With」は誤りとなります。

アクションカードの説明

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

• カードの説明は、センテンスケース（文頭の単語の最初の文字のみが大文字）で指定する必要があります。説明に名前や固有名詞が含まれる場合を除き、大文字にするのは最初の単語のみです。

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

• 検索可能性を向上させるために、説明には統合されるサービスの名前を含める必要があります。たとえば、Okta、Salesforce、Box、Zoomといった名称です。

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

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

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

• Unassigns a license from a Microsoft O365 user.（Microsoft O365ユーザーへのライセンス割り当てを解除する）

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

• Updated group details;

• Unassigns a License from a Microsoft O365 User