DiscourseのUIとドキュメントは、これらのガイドラインに沿って現在レビューおよび編集中です。できるだけ早く完全な整合を目指して取り組んでいます。
Discourseの文章を作成する際は、テキストのフォーマットに関する以下のガイドラインに注意してください。これらのガイドラインは、特にドキュメントやDiscourseのUIなど、すべての領域のテキストに適用されます。
大文字・小文字の使い分け
ドキュメントまたはUIテキストを作成する際は、文頭のみを大文字にし、それ以外は小文字にする「センテンスケース」をデフォルトとして使用してください。
重要な注意点:
- 見出し、タイトル、カテゴリ名はセンテンスケースを使用します。
- Discourseの機能名は、以下の例外を除き、大文字にしません。
機能名には、太字、イタリック、バッククォート、引用符などの他のフォーマットは一切使用しないでください。
大文字・小文字の例外:
- 頭字語は、常に適切に大文字にする必要があります。
- 製品名およびブランド名は、ブランドガイドラインに従って大文字にする必要があります。
- プラグインおよびテーマ名は、適切に大文字にする必要があります。
- メニュー項目、ボタンラベル、またはフォームオプションを参照する場合は、最初の単語の最初の文字を大文字にします。例：「新しいトピックボタンをクリックして作成を開始します。」
- UIで何らかの理由で大文字が使用されている場合は、それについてドキュメントを作成する際にも同じ大文字・小文字の使い分けを使用してください。
- カテゴリおよびURLのスラッグは、常に小文字です。
不明な場合は、センテンスケースを使用してください。
##ピリオド
以下の場合はピリオドを使用しないでください:
- ツールチップ、画像のキャプション、または1文のみのその他のUI要素
- ボタンラベル
- メニュー項目
- 動詞を含まないリスト項目
以下の場合はピリオドを使用してください:
- 通常の文
- 2文以上のツールチップ、画像のキャプション、またはその他のUI要素
- 動詞を含むリスト項目
- 画像の
altテキスト
リスト項目の注意点: 混合リスト（つまり、ピリオドが必要なものと不要なものが混在している場合）を作成している場合は、すべてにピリオドを使用してください。
強調
単語を強調するには、デフォルトでイタリックを使用してください。文脈に合っていると思われる場合は、太字を使用することもできます。
バッククォート
バッククォート（``）は、インラインコード、サンプルURL、および設定名に使用してください。それ以外の目的では使用しないでください。
コードブロック
コードブロックを含める場合は、可能な限りコーディング言語を指定してください。これは、最初のフェンス（最初の3つのバッククォート）の直後に言語名を追加することで行います。例： ```css
