メインコンテンツへスキップ
完全なスタイルガイドを参照できない場合は、以下のヒントを確認すると、コンテンツの質を大幅に高められます。

​
能動態を使う

受動態 (be動詞 + 過去分詞) は避けてください。文章をより明確で簡潔にし、動きのある表現にするため、できる限り動作主を明示して能動態を使ってください。
推奨非推奨
必要な設定を追加すると、Auth0 はこの Rule を使ってテナントのすべてのログインを処理します。本番環境で統合を有効にする前に、すべてのコンポーネントを正しく設定し、テスト用テナントで検証してください。必要な設定が追加されると、テナントのすべてのログインはこの Rule によって処理されます。本番環境で統合を有効にする前に、すべてのコンポーネントが正しく設定され、テスト用テナントで検証されていることを確認してください。
ほかのリソースにリンクする場合は、リンク先のドキュメント内の操作やタスクがわかるリンクテキストにしてください。一般的すぎるリンクテキストでは、読者は何を選べばよいか判断するために、リンクの前後の文章をすべて読む必要があり、流し読みしにくくなります。
推奨非推奨
Auth0 Dashboard または Management API を使用して、Universal Login のテキストをカスタマイズできます。こちらをクリックします。
組織のメンバーにロールを割り当てる方法については、組織メンバーへのロールの追加を参照してください。このリンクにアクセスできます。

​
デバイスに依存しない指示を書く

ユーザーインターフェースは、デバイスによって表示が異なる場合があることに注意してください。また、ユーザーが支援デバイスを使ってコンテンツを閲覧している場合もあることを考慮してください。
推奨非推奨
Create を選択します。Create をクリックします。
Applications ビューに切り替えます。Applications タブに切り替えます。
クライアントシークレット を探します。クライアントシークレット まで上にスクロールします。

​
動詞と名詞・形容詞を適切に使い分ける

動詞としても名詞・形容詞としても使える語に注意してください。英語では通常、動詞形は語を分けて書き、名詞や形容詞は複合語として続けて書けます。
推奨非推奨
Log in to your account.Login to your account.
Auth0 processes logins.Auth0 processes log ins.
Set up your hardware.Setup your hardware.
Describe your hardware setup.Describe your hardware set up.

​
見出しでは sentence case を使用する

大文字にするのは、最初の単語と、その他の固有名詞または Auth0 の製品名のみです。
推奨非推奨
Add a dependencyAdd a Dependency
Validate resumed loginValidate Resumed Login
Create an ActionCreate an action

​
見出しでは動詞の基本形を使う

見出しでは動詞の基本形を使い、不要に回りくどい表現は避けます。
推奨非推奨
ユーザーを割り当てる・変更するユーザーの割り当てと変更を行う
カスタムデータベースを接続するカスタムデータベースを接続する方法

​
手順は簡潔に書く

手順の導入文は、端的で簡潔にします。番号付きの手順リストを見れば、ユーザーは何をすべきかはすでにわかります。
推奨非推奨
SDK をインストールするには:以下の手順に従ってください:

​
手順ではユーザーが期待できる結果を示す

ユーザーが取るべき行動を説明する前に、その行動によってどのような結果になるのかを先に伝えてください。
推奨非推奨
この統合を有効にするには、Save Changes を選択します。Save Changes を選択してこの統合を有効にします。

​
手順内の操作は順番どおりに列挙する

各手順では、ユーザーが行う操作を、必要な順序で示します。
推奨非推奨
Integrations セクションを見つけて、Add Integration を選択します。Integrations セクションの下にある Add Integration を選択します。

​
注記と警告を適切に使い分ける

注記と警告は、それぞれ役割が異なります。注記には知っておくと便利な一般的な情報を記載し、警告には従わないと問題や失敗につながるおそれがある情報を記載します。 情報を警告として示す必要がある場合は、ユーザーが関連する操作を実行する箇所に、その警告を正確に記載してください。ユーザーが警告を探し回るようなことがあってはなりません。

​
詳細