インストールガイド作成時のヒント

統合を提出したいパートナー向けのガイドラインをご紹介します

スタイルガイドを最後まで読めない場合は、これらのヒントを参考にするだけでもコンテンツを大幅に改善できます。

​

能動態の使用

受動態（動詞＋受け身の表現）は避けます。明白、簡潔で躍動的なテキストになるように、できるだけ動作主と能動態を使用します。

推奨	非推奨
必要な設定を追加すると、Auth0はこのルールを使用してテナントのすべてのログインを処理します。運用環境で統合を有効化する前に、すべてのコンポーネントを正しく構成し、テストテナントで検証してください。	必要な設定が追加されると、テナントのすべてのログインはこのルールによって処理されます。運用環境での統合を有効化する前に、すべてのコンポーネントが正しく設定され、テストテナントで検証されていることを確認してください。

​

リンクのタイトルをわかりやすく

他のリソースにリンクさせる場合は、リンク先のドキュメントで説明されているアクションやタスクが一目でわかるようにします。よく使われる一般的な言葉をリンクテキストにしてしまうと、内容がすぐにはわからないため、ユーザーはリンクの前後のテキストをすべて読まざるを得ません。

推奨	非推奨
Auth0 DashboardまたはManagement APIを「ユニバーサルログインエクスペリエンスのテキストをカスタマイズする」ために使用できます。	ここをクリックします。
Organizationのメンバーにロールを割り当てる方法は、「Organizationメンバーにロールを追加する」をご覧ください。	このリンクにアクセスできます。

​

デバイスに依存しない方向性で書く

デバイスの種類によってユーザーインターフェイスの表示が変わることを忘れないでください。また、ユーザーがアダプティブデバイスでコンテンツを読んでいる可能性もあります。

推奨	非推奨
［Create（作成）］を選びます。	［Create（作成）］をクリックします。
［Applications（アプリケーション）］ビューに切り替えます。	［Applications（アプリケーション）］タブに切り替えます。
［Client Secret（クライアントシークレット）］を見つけます。	［Client Secret（クライアントシークレット）］までスクロールします。

​

動詞・名詞・形容詞の使用は正しく

同じ形で動詞・名詞または形容詞として使用できる単語に注意します。動詞形は通常、単語間にスペースが必要ですが、名詞や形容詞は複合語にすることができます。

推奨	非推奨
アカウントにログイン（log in）します。	アカウントにログイン（login）します。
Auth0がログイン（logins）を処理します。	Auth0がログイン（log ins）を処理します。
ハードウェアをセットアップ（set up）します。	ハードウェアをセットアップ（setup）します。
ハードウェアセットアップ（setup）を説明します。	ハードウェアセットアップ（set up）を説明します。

​

見出し文での大文字・小文字

文頭、固有名詞、Auth0の製品名のみ単語の先頭文字を大文字にします。

推奨	非推奨
依存性を追加する	依存性を追加する
再開されたログインの検証	再開されたログインの検証
アクションの作成	アクションの作成

​

見出しには単純時制を使用

見出しには単純時制を使用して、くどい言い回しを避けます。

推奨	非推奨
ユーザーを割り当てる・変更する	ユーザーを割当中・変更中
カスタムデータベースを接続する	カスタムデータベースを接続する方法

​

手順は簡潔に

手順を紹介するテキストを書く際は、はっきりと簡潔にします。ユーザーは、番号の付いた箇条書きを見れば、手順であると承知しています。

推奨	非推奨
SDKのインストール方法：	以下の手順に従ってください：

​

ステップの結果を示す

必要な作業について説明する前に、そのステップが終わるとどのような結果になるかをあらかじめ示しておきます。

推奨	非推奨
この統合を有効化するには、［Save Changes（変更を保存する）］を選択してください。	［Save Changes（変更を保存する）］を選択して、この統合を有効化します。

​

ステップ内での作業を順番に挙げる

それぞれのステップでは、ユーザーが行うべき作業を行うべき順に記載します。

推奨	非推奨
［Integrations（統合）］を見つけ、［Add Integration（統合を追加する）］を選択します。	［Integrations（統合）］セクションにある［Add Integration（統合を追加する）］を選択します。

​

注意や警告の使用は正しく

注意と警告は、果たす役割が異なります。注意では、知っておくと便利な一般情報を紹介し、警告には、従わないとエラーにつながってしまう情報を記載します。

警告に値する情報があるときは、それに関連する作業をユーザーが行う箇所に記載します。警告は、ユーザーが探さなくても目に入らなければなりません。

​

もっと詳しく

• マーケットプレイスパートナー
• パートナー向けリダイレクトアクション
• パートナーに対するソーシャル接続
• パートナーのSSO統合