リスト
リストには3つのタイプがあります：
- 順不同の項目のための箇条書きリスト
- 順序付きの項目のための番号付きリスト
- 文中の項目のための埋め込みリスト
リストを作成する際のいくつかのヒント：
- リスト項目を平行に保つ
- 番号付きリストは命令形の動詞で始める
- リスト内で適切な文と句読点を使用して一貫して句読点を付ける（完全な文にはピリオドなど）
- マークダウンの番号付きリストでは、番号は1のみを使用する。マークダウンは自動的に番号を作成するため、ステップを削除するとマークダウンが出力と一致しなくなる可能性があります。
箇条書きは、読者の目を重要な要素のリストに集中させるのに役立ちます。
しかし、他の執筆の側面と同様に、注意深く使用する必要があります。以下は、箇条書きを使用すべき場合と使用すべきでない場合のリストです。
| ❌ 箇条書きを使用しない | ✅ 箇条書きを使用する |
|---|---|
| プロセスを概説するため（番号付きリストを優先） | 事実をリストするため |
| あなたの理由を説明するため（ブログ投稿であり、システム要件のリストではない） | データをリストするため |
| - | オプションをリストするため |
指示は番号付きのステップであるべきであり、箇条書きではありません。追加情報についてはステップ/タスク/手順を参照してください。
箇条書きの項目が完全な文である場合を除き、箇条書きに句読点を付けないでください。
箇条書きの項目の後に説明が続く場合は、見出しの後にコロンを使用し、説明を大文字にします。例えば、
- 項目 1: 説明 1
- 項目 2: 説明 2
箇条書きでは、「シックスパック」ルールを守るようにしましょう：6つを超えない箇条書き、各項目は6語以下で構成されること。
追加のガイダンスについては箇条書きを使用する最良の方法 ↗を参照してください。
箇条書きを作成しているときは、このチェックリストを確認してください：
- すべての箇条書きは一緒に属していますか？
- リスト内のすべての要素が論理的に関連していることを確認してください。
- 箇条書きが3つ以上、6つ未満ありますか？
- 読者は長いリストを読むと迷子になります。同時に、リストする要素が3つ未満の場合、箇条書きを使用する必要がありますか？
- すべての箇条書きは3行未満のテキストですか？
- 箇条書きはセクションの見出しとして使用すべきではありません。箇条書きが過度に長い場合は、リストをいくつかのサブセクションに分けることを検討してください。
- 句読点は一貫していますか？
- 各要素が完全な文である場合は、箇条書きのすべての要素の最後にピリオドを付けてください；名詞やパラメータをリストしているだけの場合は、句読点を追加しないでください。
- すべての箇条書きは、読者に覚えてほしい最も重要な単語で始まっていますか？
- 箇条書きの「見出し」が長い回り道の後に隠れていないことを確認してください。
- すべての箇条書きは同じ品詞で始まっていますか？
- 箇条書きが動詞で始まる場合は、すべての動詞が同じ気分/時制であることを確認してください。