認証
ユーザー管理
カスタマイズ
プラットフォームインストールガイド作成のヒント
Auth0 がマーケットプレイス連携のインストールガイドに求める執筆ガイドラインを確認できます。
詳細なスタイルガイドを参照できない場合は、以下のヒントを確認することで、コンテンツを大幅に改善できます。
受動態 (be動詞 + 過去分詞) は避けましょう。文章をより生き生きと、明確にし、そして多くの場合はより簡潔にするため、できるだけ主体を明確にして能動態を使うようにしてください。
ほかのリソースにリンクする場合は、リンク先のドキュメントで行うアクションやタスクがわかるリンクテキストにしてください。汎用的なリンクテキストを使うと、読者は何を選べばよいかを判断するために、リンクの前後の文章をすべて読まなければならず、一覧性が下がります。
ユーザーインターフェースは、デバイスによって表示が異なることがあります。また、ユーザーが支援技術を使ってコンテンツを閲覧している場合もあることを忘れないでください。
動詞としても名詞や形容詞としても使える語には注意してください。動詞形では通常、語と語の間にスペースが必要ですが、名詞や形容詞では複合語にできます。
大文字にするのは、最初の語と固有名詞、Auth0 の製品名のみです。
見出しではシンプルな時制を使い、不要に冗長な表現は避けてください。
手順の導入文を書くときは、端的で簡潔にしましょう。番号付きの手順があれば、ユーザーは何をすべきかをすでに理解できます。
ユーザーに取ってもらいたい行動を説明する前に、その行動によってどのような結果になるのかを伝えてください。
各ステップでは、ユーザーが行う操作を必要な順序どおりに示します。
注記と警告では役割が異なります。注記には知っておくと役立つ一般的な情報を記載し、警告には従わないと問題や失敗につながるおそれがある情報を記載します。
情報を警告として示す必要がある場合は、ユーザーが関連する操作を行うまさにその箇所に警告を記載してください。ユーザーに警告を探させてはいけません。