# 画面設計書 6-About - Why Prettier?

## 概要

本ドキュメントはPrettierドキュメントの「Why Prettier?」ページの画面設計書です。Prettierを使う理由を説明するドキュメントページとして機能します。

### 本画面の処理概要

本画面はPrettierを採用する理由とメリットを、実際のユーザーの声を交えながら説明するドキュメントページです。スタイルガイドの統一、新人支援、コーディング効率化、導入の容易さなど、様々な観点からPrettierの価値を伝えます。

**業務上の目的・背景**：Prettierの導入を検討しているチームや開発者に対して、なぜPrettierを採用すべきかの根拠を提供します。特に「スタイルに関する議論を終わらせる」という主要なメリットを強調し、チームでの導入説得の材料となることを目的としています。

**画面へのアクセス方法**：
- ホームページの「And more」リンクをクリック
- サイドバーの「Why Prettier?」をクリック
- ブラウザで直接 `https://prettier.io/docs/why-prettier` にアクセス

**主要な操作・処理内容**：
1. Prettierを使う理由の各セクションの閲覧
2. 実際のユーザーの引用コメントの確認
3. サイドバーを通じた他のドキュメントページへの遷移

**画面遷移**：
- 遷移元：ホームページ、Prettier概要ページ、サイドバー
- 遷移先：サイドバー経由で他のドキュメントページ、外部リンク

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

## 関連機能

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

## 画面種別

ドキュメント / 情報提示

## URL/ルーティング

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

## 入出力項目

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

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

## 表示項目

| セクション | 項目名 | 表示形式 | データソース |
|------------|--------|----------|--------------|
| ヘッダー | ページタイトル | H1テキスト | Front Matter（title: Why Prettier?） |
| セクション1 | Building and enforcing a style guide | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| セクション2 | Helping Newcomers | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| セクション3 | Writing code | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| セクション4 | Easy to adopt | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| セクション5 | Clean up an existing codebase | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| セクション6 | Ride the hype train | H2 + 本文 + 引用リスト | Markdownコンテンツ |
| サイドバー | ドキュメントナビゲーション | リンクリスト | sidebars.js |

## イベント仕様

### 1-外部リンククリック

本文中の外部リンク（Smashing Magazineの記事など）をクリックすると、外部サイトへ遷移します。

**処理フロー**：
1. 外部リンククリックイベント発火
2. 外部サイトへ遷移

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

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

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

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

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

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

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

## メッセージ仕様

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

## 例外処理

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

## 備考

- 本画面はDocusaurus docs機能でMarkdownから生成されます
- 6つのセクションで構成され、それぞれにユーザーの引用コメントを含む
- ユーザーの声は箇条書きで表示
- スタイルガイドの重要性に関する外部記事へのリンクを含む

---

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

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

### 推奨読解順序

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

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

**読解のコツ**: 各セクションの構造（H2見出し + 説明文 + 引用リスト）を理解することが重要です。

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | why-prettier.md | `docs/why-prettier.md` | 6つのセクション構成 |

**主要コンテンツ**:
1. **1-4行目**: Front Matter（id, title）
2. **6-19行目**: Building and enforcing a style guide
3. **20-28行目**: Helping Newcomers
4. **29-36行目**: Writing code
5. **37-46行目**: Easy to adopt
6. **47-53行目**: Clean up an existing codebase
7. **54-62行目**: Ride the hype train

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

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

### データフロー図

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

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

### 関連ファイル一覧

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