Skip to content

非公式本サイトは非公式の日本語ドキュメントであり、Cloudflare 公式サイトではありません。最新情報はdevelopers.cloudflare.comをご確認ください。

リスト

最終更新 Markdown で表示Agent セットアップ

リストには 3 種類あります。

  • 順序のない項目には箇条書きリスト
  • 順序のある項目には番号付きリスト
  • 文中の項目には埋め込みリスト

リストを作るときのポイントです。

  • 項目は並列構造にする
  • 番号付きリストは命令(命令形の動詞)で始める
  • リスト内では、文と句読点を一貫して使う(完全な文にはピリオドなど)

箇条書き

箇条書きは、重要な要素の一覧に読者の目を向けます。

ただし、文章のほかの要素と同様、意識して使います。箇条書きを使うべきときと、使うべきでないときの一覧です。

❌ 箇条書きを使わない✅ 箇条書きを使う
手順 を示す(番号付きリストを優先する)事実 を列挙する
理由を説明する(システム要件の一覧ではなく、ブログ記事である)データ を列挙する
-選択肢 を列挙する

箇条書きリスト

手順は番号付きステップにし、箇条書きにはしません。詳細は ステップ / タスク / 手順 を参照してください。

各項目が完全な文でない限り、箇条書きには句読点を付けません。

箇条書きの項目のあとに説明が続く場合は、見出しのあとにコロンを置き、説明の先頭を大文字にします。例:

  • Item 1: Description 1
  • Item 2: Description 2

箇条書きは「6 パック」ルールに従います。箇条書きは 6 個まで、各項目は 6 語以内です。

追加の指針は The best way to use bullet points を参照してください。

箇条書きリストのチェックリスト

箇条書きの一覧を作るときは、次のチェックリストを確認します。

  1. すべての箇条書きは同じグループに属していますか?
    • リスト内の要素が論理的につながっていることを確認します。
  2. 箇条書きは 3 個以上、6 個未満ですか?
    • 長いリストでは読者が迷います。一方、要素が 3 個未満なら、箇条書きが必要かどうか考えます。
  3. すべての箇条書きは 3 行未満ですか?
    • 箇条書きをセクション見出し代わりに使ってはいけません。箇条書きが長すぎる場合は、リストを複数のサブセクションに分割することを検討します。
  4. 句読点は一貫していますか?
    • 各要素が完全な文なら、箇条書きの全要素をピリオドで終えます。名詞やパラメーターを列挙しているだけなら、句読点は付けません。
  5. すべての箇条書きは、読者に覚えてほしい最も重要な語で始まっていますか?
    • 箇条書きの先頭が、長い遠回しな言い回しのあとに隠れていないことを確認します。
  6. すべての箇条書きは、同じ品詞で始まっていますか?
    • 動詞で始める場合は、法と時制を揃えます。

役に立ちましたか?