コンテンツの整理

効果的なコンテンツ整理は、ユーザーが直感的にナビゲートし、情報を迅速に見つけられるドキュメントの作成に不可欠です。

コンテンツ階層

ディレクトリ構造

明確な階層を使用してコンテンツを整理：

src/content/docs/[lang]/[version]/
├── 01-guide/           # 入門とチュートリアル
│   ├── 01-getting-started.mdx
│   ├── 02-creating-documents.mdx
│   └── 03-editing-documents.mdx
├── 02-components/      # UIコンポーネントと例
│   ├── 01-overview.mdx
│   ├── 02-icons.mdx
│   └── 03-tabs.mdx
├── 03-advanced/        # 高度なトピック
│   ├── 01-customization.mdx
│   └── 02-automation.mdx
└── 04-reference/       # リファレンス資料
    ├── 01-frontmatter.mdx
    └── 02-configuration.mdx

番号付け規則

順序を制御するために番号接頭辞を使用：

• カテゴリ：01-guide/、02-components/、03-advanced/
• ドキュメント：01-getting-started.mdx、02-installation.mdx

これによりファイルシステムの動作に関係なく一貫した順序が保証されます。

カテゴリ設計

目的ベースのカテゴリ

ユーザーの意図とワークフローで整理：

段階的な学習パス

ユーザーの旅に合わせてコンテンツを構造化：

1. 【入門】 基本概念と最初の手順
   ↓
2. 【実用】 日常的なタスクとワークフロー
   ↓
3. 【高度】 カスタマイズと最適化
   ↓
4. 【参照】 詳細なリファレンス

ドキュメント内構造

情報階層

各ドキュメント内で論理的な流れを使用：

# タイトル
概要と学習内容

## 主要概念
基本的な理解

## 基本的な使用法
実用的な例

## 高度な使用法
より複雑なシナリオ

## ベストプラクティス
推奨事項

## 次のステップ
関連コンテンツへのリンク

見出し階層

一貫した見出し構造を維持：

• H1 (#)：ページタイトルのみ
• H2 (##)：主要セクション
• H3 (###)：サブセクション
• H4以下：必要に応じてのみ使用

クロスリファレンス

戦略的なリンク

関連コンテンツを効果的に接続：

<!-- 概念から実装へ */}
基本を理解したら、[実際の例](/ja/v2/guide/creating-documents)を試してください。

<!-- 詳細情報への参照 */}
より詳しくは[完全なAPIリファレンス](/ja/v2/reference/api)をご覧ください。

<!-- 段階的な進行 */}
次に[高度なカスタマイズ](/ja/v2/advanced/customization)に進みましょう。

リンクパターン

一貫したリンクテキストを使用：

<!-- 良い例 */}
[ドキュメントの作成](/ja/v2/guide/creating-documents)
[コンポーネント概要](/ja/v2/components/overview)

<!-- 避けるべき例 */}
[こちら](/ja/v2/guide/creating-documents)
[詳細](/ja/v2/components/overview)

ナビゲーション設計

自動ナビゲーション

ファイル構造に基づく自動生成を活用：

• サイドバー：ディレクトリ構造から生成
• 前/次リンク：ファイル順序から自動
• パンくずリスト：階層から自動生成

カスタムナビゲーション

必要に応じて明示的なリンクを提供：

## 関連トピック

このセクションと関連する内容：

- [基本セットアップ](/ja/v2/guide/getting-started)
- [コンポーネントの使用](/ja/v2/components/overview)
- [デプロイガイド](/ja/v2/advanced/deployment)

コンテンツガイドライン

一貫性の維持

すべてのドキュメントで統一：

• 用語：同じ概念には同じ言葉を使用
• フォーマット：コードブロック、リスト、強調の使用
• 声調：文体とトーンの一貫性
• 構造：類似ドキュメントの類似構造

内容の重複を避ける

• 単一の情報源：各概念を一箇所で説明
• 参照による接続：重複ではなくリンクを使用
• 要約の提供：必要に応じて簡潔な要約

内容の種類別戦略

チュートリアル

段階的な学習体験：

---
title: "初めてのドキュメント作成"
description: "ゼロから完全なドキュメントを作成する完全ガイド"
---

# 初めてのドキュメント作成

このチュートリアルでは、最初から最後まで完全なドキュメントを作成します。

## 学習内容

このガイドを完了すると、以下ができるようになります：
- 新しいドキュメントファイルの作成
- 適切なフロントマターの追加
- 効果的なコンテンツの記述

## 前提条件

- 基本的なMarkdownの知識
- プロジェクトの開発環境がセットアップ済み

## ステップ1：ファイルの作成
[詳細な手順...]

リファレンス

迅速な参照のための構造化：

---
title: "設定オプション"
description: "利用可能なすべての設定オプションの完全なリファレンス"
---

# 設定オプション

## 基本設定

### title
- **型**: string
- **必須**: はい
- **説明**: ドキュメントのタイトル
- **例**: `"私のガイド"`

### description
- **型**: string
- **必須**: はい
- **説明**: ドキュメントの簡潔な説明
- **例**: `"このガイドでは基本的な使用法を説明します"`

品質保証

整理チェックリスト

新しいコンテンツを追加する前に：

• 論理的な配置：適切なカテゴリに配置
• 命名の一貫性：既存のパターンに従う
• 順序の確認：論理的な進行を維持
• 重複の確認：既存コンテンツとの重複なし
• リンクの更新：関連ドキュメントに相互リンク

定期的なレビュー

コンテンツ構造を定期的に評価：

1. 使用パターンの分析：どのパスが最も使用されるか
2. ギャップの特定：欠けている接続やコンテンツ
3. 再構成の検討：より良い整理が可能か
4. フィードバックの収集：ユーザーからの改善提案

次のステップ

コンテンツ整理の原則を理解したら：

• バージョン管理：複数バージョンの効果的な管理方法
• コンポーネントの使用：ドキュメントを強化するUIコンポーネント
• 自動化：コンテンツ管理の自動化ツール