ドキュメントバージョニング概要
サンプルドキュメントプロジェクトへようこそ!このガイドでは、ドキュメントのバージョニングの概念と、v1やv2のように異なるバージョン間でコンテンツを整理する方法について説明します。
ドキュメントバージョニングとは?
ドキュメントバージョニングにより、複数のバージョンのドキュメントを同時に維持できます。これは特に以下の場合に有用です:
- ソフトウェアやAPIの異なるバージョンがある場合
- 新機能を開発中に古いバージョンのユーザーをサポートする必要がある場合
- ユーザーを一つのバージョンから別のバージョンに段階的に移行させたい場合
- 後方互換性のドキュメントを維持する必要がある場合
なぜv1とv2を分けるのか?
このプロジェクトでは、コンテンツを別々のディレクトリに整理することでバージョニングを実現しています:
docs/
├── en/ # 英語版
│ ├── v1/ # バージョン1ドキュメント
│ │ └── guide/
│ └── v2/ # バージョン2ドキュメント
│ ├── guide/
│ ├── components/
│ ├── advanced/
│ └── reference/
└── ja/ # 日本語版
├── v1/
└── v2/
バージョン1(現在のページ)
- 目的: バージョニング概念のシンプルな紹介を提供
- コンテンツ: 基本的な概要と方向性
- 対象者: ドキュメント構造に慣れ親しもうとするユーザー
バージョン2(メインドキュメント)
- 目的: 詳細なガイドと例を含む包括的なドキュメント
- コンテンツ: 完全なドキュメント作成・編集ガイド
- 対象者: ドキュメントの作成と管理に取り組む準備ができたユーザー
このアプローチの利点
- 明確な分離: 各バージョンが専用のスペースを持つ
- 独立した進化: バージョンが独立して進化できる
- ユーザーの選択: ユーザーがニーズに合ったバージョンを選択できる
- 移行パス: 基本から高度なコンテンツへの明確な進歩
ディレクトリ構造の利点
バージョン固有のディレクトリでコンテンツを整理することで、以下が得られます:
- 整理されたURL:
/ja/v1/guide/
や/ja/v2/guide/
のようなクリーンなパス - 独立したナビゲーション: 各バージョンが独自のサイドバー構造を持てる
- 柔軟なコンテンツ: 異なるバージョンが完全に異なるコンテンツ構成を持てる
- 簡単なメンテナンス: 一つのバージョンへの変更が他に影響しない
多言語サポート
このバージョニングアプローチは多言語サポートとシームレスに動作します:
- 各言語(
en
、ja
)が独自のバージョンディレクトリを持つ - コンテンツを各バージョンごとに独立して翻訳できる
- URL構造がクリーンで予測可能に保たれる
- ユーザーが同じバージョン内で言語を切り替えられる
次のステップ
包括的なドキュメント作成を探索する準備はできましたか?以下を含むバージョン2をチェックしてください:
- 完全なドキュメントガイド: ドキュメントの作成、編集、整理方法を学ぶ
- コンポーネント例: アイコン、タブなどの利用可能なUIコンポーネントを発見
- 高度なトピック: カスタマイゼーション、自動化、デプロイメントを探索
- リファレンス資料: 設定と記法に関する詳細情報を見つける
技術的実装
このバージョニングシステムは以下を使用して構築されています:
- ディレクトリベースルーティング: Astroのファイルベースルーティングシステム
- 動的サイドバー生成: コンテンツ構造に基づいてナビゲーションを自動生成
- フロントマター設定: メタデータを使用して順序とカテゴリ化を制御
- 多言語サポート: 組み込み国際化機能
バージョン情報はproject.config.ts
で設定され、以下が可能です:
- 利用可能なバージョンの定義
- 最新バージョンの設定
- バージョン固有のメタデータの設定
- バージョン表示名と日付の管理