コンテンツにスキップ

注意事項/ヒント/警告

定義

テキストや画像、リスト、コードブロックなどのコンテンツを含むカラフルな情報ボックスまたはサイドで、テキストに合わない関連ノートを追加したり、機能を破壊したりセキュリティに影響を与える特定の行動についてユーザーに警告したりします。

使用例

How toConfigurationFAQConceptReferenceTutorial

構造

タイプ: ノートまたは警告(背景色を定義)

サイドコンテンツ

(オプション)タイトル/ヘッダー

テンプレート

Asidesを参照して、Asidesの作成方法を学んでください。

表示例

追加情報

サイドの背景色はサイドのタイプによって異なります:

  • 「note」タイプのサイド — 青
  • 「warning」タイプのサイド — オレンジ

サイドには、太字で表示されるオプションのヘッダーが上部(カラーボックス内)に表示されます。

サイドには、単一の文または追加のコンテンツ(リスト、コードブロック、画像)を含めることができます。

ノート/警告はいつ使用すべきですか?

ノートを使用して、テキストに統合できない追加の有用な情報を読者に警告します。

警告を使用して、ユーザーのネットワークのセキュリティに影響を与えたり、機能を破壊したりする可能性のある行動について読者に警告します。

推奨事項

  • サイドにはあまり多くのコンテンツを含めるべきではありません。通常のテキストの流れを壊すためです。例えば、最大3段落または3項目までの箇条書きリスト。より多くのコンテンツを含める必要がある場合は、「重要なノート」などのドキュメントセクションを作成することを検討してください。
  • サイドは控えめに使用してください。 各セクションには同じタイプのサイドが1つ以上あってはいけません。唯一の例外は、見出しの直後に可能な可用性の免責事項です。
  • タスクステップの指示内のサイドにはヘッダーを含めないでください。 スペースを取りすぎて、背景色だけでサイドのコンテンツを通常のテキストと区別するのに十分です。
  • 機能の制限された可用性を示すためにnoteサイドを使用してください(例えば、「エンタープライズプランの顧客のみ利用可能。」)ページの冒頭に、ヘッダーなしで。