# 画面設計書 7-About - Comparison

## 概要

本ドキュメントはPrettierドキュメントの「Prettier vs. Linters」ページの画面設計書です。Prettierと他のリンター/フォーマッターツールとの比較を説明するドキュメントページとして機能します。

### 本画面の処理概要

本画面はPrettierとESLint、TSLint、stylelintなどのリンターツールとの違いを明確に説明し、それぞれの役割分担を理解させるドキュメントページです。

**業務上の目的・背景**：開発者がPrettierとリンターツールの違いを理解できず、どちらを使うべきか、または両方をどのように併用すべきか迷うケースが多いため、その疑問に答えることを目的としています。「Prettierはフォーマット用、リンターはバグ検出用」という明確なメッセージを伝えます。

**画面へのアクセス方法**：
- サイドバーの「Comparison」をクリック
- ブラウザで直接 `https://prettier.io/docs/comparison` にアクセス

**主要な操作・処理内容**：
1. リンターのルールカテゴリ（フォーマットルール、コード品質ルール）の理解
2. Prettierとリンターの役割分担の理解
3. サイドバーを通じた他のドキュメントページへの遷移

**画面遷移**：
- 遷移元：サイドバー、Why Prettier?ページ
- 遷移先：サイドバー経由で他のドキュメントページ、ESLintドキュメント（外部）

**権限による表示制御**：本画面は公開ページのため、権限による表示制御はありません。全ての訪問者が同一のコンテンツを閲覧できます。

## 関連機能

| 機能No | 機能名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | 本画面には直接関連する機能はありません（説明ドキュメント） |

## 画面種別

ドキュメント / 情報提示

## URL/ルーティング

- URL: `/docs/comparison`
- ファイルパス: `docs/comparison.md`
- Docusaurus docs機能で生成

## 入出力項目

本画面はユーザー入力を受け付けない表示専用ページです。

| 項目名 | 入出力 | 型 | 必須 | 説明 |
|--------|--------|-----|------|------|
| - | - | - | - | 入力項目なし |

## 表示項目

| セクション | 項目名 | 表示形式 | データソース |
|------------|--------|----------|--------------|
| ヘッダー | ページタイトル | H1テキスト | Front Matter（title: Prettier vs. Linters） |
| 本文 | 質問見出し | H2テキスト | Markdownコンテンツ |
| 本文 | フォーマットルールの説明 | テキスト + リンクリスト | Markdownコンテンツ |
| 本文 | コード品質ルールの説明 | テキスト + リンクリスト | Markdownコンテンツ |
| 本文 | 結論 | 強調テキスト | Markdownコンテンツ |
| サイドバー | ドキュメントナビゲーション | リンクリスト | sidebars.js |

## イベント仕様

### 1-ESLintルールリンククリック

ESLintルールのリンクをクリックすると、ESLint公式ドキュメントへ遷移します。

**処理フロー**：
1. ルールリンククリックイベント発火
2. ESLint公式ドキュメントの該当ルールページへ遷移

### 2-サイドバーナビゲーション

サイドバーのリンクをクリックすると、他のドキュメントページへ遷移します。

**処理フロー**：
1. サイドバーリンククリックイベント発火
2. 選択したドキュメントページへ遷移

## データベース更新仕様

本画面はデータベースを使用しません。

### 操作別データベース影響一覧

| 操作（イベント） | 対象テーブル | 操作種別 | 概要 |
|----------------|-------------|---------|------|
| - | - | - | データベース操作なし |

## メッセージ仕様

| メッセージID | 種別 | メッセージ内容 | 表示条件 |
|-------------|------|----------------|----------|
| - | - | - | 本画面ではメッセージ表示なし |

## 例外処理

| 例外ケース | 処理内容 | ユーザーへの表示 |
|-----------|----------|-----------------|
| - | - | 例外ケースなし（静的ドキュメント） |

## 備考

- 本画面はDocusaurus docs機能でMarkdownから生成されます
- 簡潔なドキュメントで、フォーマットルールとコード品質ルールの2つのカテゴリを説明
- ESLintルールへの外部リンクを多数含む
- 結論を太字で強調表示

---

## コードリーディングガイド

本画面を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: ドキュメント構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | comparison.md | `docs/comparison.md` | ドキュメントのMarkdownソース |

**読解のコツ**: シンプルな構造で、2つのルールカテゴリを対比的に説明していることを理解します。

#### Step 2: コンテンツ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | comparison.md | `docs/comparison.md` | ルールカテゴリの説明 |

**主要コンテンツ**:
1. **1-4行目**: Front Matter（id, title）
2. **6行目**: H2見出し「How does it compare to ESLint/TSLint/stylelint, etc.?」
3. **8-10行目**: Formatting rulesの説明
4. **12-14行目**: Code-quality rulesの説明
5. **16-18行目**: 結論（太字）

### プログラム呼び出し階層図

```
comparison.md (Markdownソース)
    │
    ├─ Docusaurus docs plugin
    │      └─ Markdownパース
    │
    ├─ Front Matter処理
    │      └─ id, title抽出
    │
    ├─ sidebars.js
    │      └─ サイドバー生成
    │
    └─ Docusaurusテーマ
           └─ ページレンダリング
```

### データフロー図

```
[入力]                        [処理]                           [出力]

docs/comparison.md      ───▶ Docusaurusビルド           ───▶ HTMLページ
         │
         ▼
Front Matter            ───▶ メタデータ抽出             ───▶ ページタイトル
         │
         ▼
Markdownコンテンツ      ───▶ MDX変換                   ───▶ Reactコンポーネント
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| comparison.md | `docs/comparison.md` | ドキュメント | メインMarkdownソース |
| sidebars.js | `website/sidebars.js` | 設定 | サイドバーナビゲーション構成 |
| docusaurus.config.js | `website/docusaurus.config.js` | 設定 | Docusaurus全体設定 |
