> ## Documentation Index
> Fetch the complete documentation index at: https://translations.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

> Auth0 がマーケットプレイス連携のインストールガイドに求める執筆ガイドラインを確認できます。

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

詳細なスタイルガイドを参照できない場合は、以下のヒントを確認することで、コンテンツを大幅に改善できます。

<div id="use-active-voice">
  ## 能動態を使う
</div>

受動態 (be動詞 + 過去分詞) は避けましょう。文章をより生き生きと、明確にし、そして多くの場合はより簡潔にするため、できるだけ主体を明確にして能動態を使うようにしてください。

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

<div id="make-link-titles-scannable">
  ## リンクテキストをひと目でわかるものにする
</div>

ほかのリソースにリンクする場合は、リンク先のドキュメントで行うアクションやタスクがわかるリンクテキストにしてください。汎用的なリンクテキストを使うと、読者は何を選べばよいかを判断するために、リンクの前後の文章をすべて読まなければならず、一覧性が下がります。

| 推奨                                                                                                                                                          | 非推奨                                      |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| Auth0 Dashboard または Management API を使用して、[Universal Login エクスペリエンスのテキストをカスタマイズ](/docs/ja-jp/customize/login-pages/universal-login/customize-templates)できます。 | [こちら](/docs/ja-jp/get-started)をクリックします。  |
| 組織のメンバーにロールを割り当てる方法については、[organization のメンバーにロールを追加する](/docs/ja-jp/manage-users/organizations/configure-organizations/add-member-roles)を参照してください。           | [このリンク](/docs/ja-jp/get-started)に移動できます。 |

<div id="write-device-agnostic-directions">
  ## デバイスに依存しない指示を書く
</div>

ユーザーインターフェースは、デバイスによって表示が異なることがあります。また、ユーザーが支援技術を使ってコンテンツを閲覧している場合もあることを忘れないでください。

| 推奨                       | 非推奨                             |
| ------------------------ | ------------------------------- |
| **Create** を選択します。       | **Create** をクリックします。            |
| **アプリケーション**表示に切り替えます。   | **アプリケーション**タブに切り替えます。          |
| **Client Secret** を探します。 | **Client Secret** まで上にスクロールします。 |

<div id="use-verbs-and-nounadjectives-properly">
  ## 動詞と名詞・形容詞を適切に使い分ける
</div>

動詞としても名詞や形容詞としても使える語には注意してください。動詞形では通常、語と語の間にスペースが必要ですが、名詞や形容詞では複合語にできます。

| 推奨                            | 非推奨                            |
| ----------------------------- | ------------------------------ |
| 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. |

<div id="use-sentence-case-for-headings">
  ## 見出しでは文頭の語のみ大文字にする
</div>

大文字にするのは、最初の語と固有名詞、Auth0 の製品名のみです。

| 推奨                     | 非推奨                    |
| ---------------------- | ---------------------- |
| Add a dependency       | Add a Dependency       |
| Validate resumed login | Validate Resumed Login |
| Create an Action       | Create an action       |

<div id="use-simple-tense-for-headings">
  ## 見出しではシンプルな時制を使う
</div>

見出しではシンプルな時制を使い、不要に冗長な表現は避けてください。

| 推奨              | 非推奨               |
| --------------- | ----------------- |
| ユーザーを割り当てて変更する  | ユーザーの割り当てと変更を行う   |
| カスタムデータベースを接続する | カスタムデータベースを接続する方法 |

<div id="write-steps-concisely">
  ## 手順は簡潔に書く
</div>

手順の導入文を書くときは、端的で簡潔にしましょう。番号付きの手順があれば、ユーザーは何をすべきかをすでに理解できます。

| 推奨               | 非推奨            |
| ---------------- | -------------- |
| SDK をインストールするには: | 以下の手順に従ってください: |

<div id="set-user-expectations-in-steps">
  ## ステップ内でユーザーの期待を設定する
</div>

ユーザーに取ってもらいたい行動を説明する前に、その行動によってどのような結果になるのかを伝えてください。

| 推奨                             | 非推奨                          |
| ------------------------------ | ---------------------------- |
| この連携を有効化するには、**変更を保存** を選択します。 | **変更を保存** を選択して、この連携を有効化します。 |

<div id="list-actions-within-steps-in-order">
  ## 各ステップ内の操作は順番に並べる
</div>

各ステップでは、ユーザーが行う操作を必要な順序どおりに示します。

| 推奨                                  | 非推奨                                 |
| ----------------------------------- | ----------------------------------- |
| **連携** セクションを見つけて、**連携を追加** を選択します。 | **連携** セクションの下にある **連携を追加** を選択します。 |

<div id="use-notes-and-warning-appropriately">
  ## 注記と警告を適切に使い分ける
</div>

注記と警告では役割が異なります。注記には知っておくと役立つ一般的な情報を記載し、警告には従わないと問題や失敗につながるおそれがある情報を記載します。

情報を警告として示す必要がある場合は、ユーザーが関連する操作を行うまさにその箇所に警告を記載してください。ユーザーに警告を探させてはいけません。

<div id="learn-more">
  ## 詳細
</div>

* [マーケットプレイスパートナー](/docs/ja-jp/customize/integrations/marketplace-partners)
* [パートナー向け Redirect Actions](/docs/ja-jp/customize/integrations/marketplace-partners/redirect-actions-for-partners)
* [パートナー向けソーシャル接続](/docs/ja-jp/customize/integrations/marketplace-partners/social-connections-for-partners)
* [パートナー向け SSO 連携](/docs/ja-jp/customize/integrations/marketplace-partners/sso-integrations-for-partners)
