認証
ユーザー管理
カスタマイズ
Auth0 AI
プラットフォームインストールガイド執筆のヒント
統合を提出するパートナー向けの執筆ガイドラインを説明します
完全なスタイルガイドを参照できない場合は、以下のヒントを確認すると、コンテンツの質を大幅に高められます。
受動態 (be動詞 + 過去分詞) は避けてください。文章をより明確で簡潔にし、動きのある表現にするため、できる限り動作主を明示して能動態を使ってください。
ほかのリソースにリンクする場合は、リンク先のドキュメント内の操作やタスクがわかるリンクテキストにしてください。一般的すぎるリンクテキストでは、読者は何を選べばよいか判断するために、リンクの前後の文章をすべて読む必要があり、流し読みしにくくなります。
ユーザーインターフェースは、デバイスによって表示が異なる場合があることに注意してください。また、ユーザーが支援デバイスを使ってコンテンツを閲覧している場合もあることを考慮してください。
動詞としても名詞・形容詞としても使える語に注意してください。英語では通常、動詞形は語を分けて書き、名詞や形容詞は複合語として続けて書けます。
大文字にするのは、最初の単語と、その他の固有名詞または Auth0 の製品名のみです。
見出しでは動詞の基本形を使い、不要に回りくどい表現は避けます。
手順の導入文は、端的で簡潔にします。番号付きの手順リストを見れば、ユーザーは何をすべきかはすでにわかります。
ユーザーが取るべき行動を説明する前に、その行動によってどのような結果になるのかを先に伝えてください。
各手順では、ユーザーが行う操作を、必要な順序で示します。
注記と警告は、それぞれ役割が異なります。注記には知っておくと便利な一般的な情報を記載し、警告には従わないと問題や失敗につながるおそれがある情報を記載します。
情報を警告として示す必要がある場合は、ユーザーが関連する操作を実行する箇所に、その警告を正確に記載してください。ユーザーが警告を探し回るようなことがあってはなりません。