ドキュメントの使い方
Prism Architectureのドキュメントは、異なる学習スタイル、知識レベル、特定のニーズをサポートするように構成されています。このガイドは、あなたの目標と背景に基づいて、ドキュメントを効果的に活用するためのお手伝いをします。
ドキュメント構造
ドキュメントは、基本的な概念から高度な実装まで段階的に進む階層構造で構成されています：
00 - イントロダクション
あなたは今ここにいます！このセクションでは、Prism Architectureの概要、その利点、および誰が使用すべきかについて説明します。すべての人にとって完璧な出発点です。
01 - 第1階層: 基礎
これらのコアドキュメントはPrism Architectureの基本的な概念を説明します：
- アーキテクチャ概要: 基本原則、レイヤー定義、およびコミュニケーションパターン
- コアコンセプト: エンティティ、サービス、ユースケース、プレゼンターなどの主要なアーキテクチャ要素
- はじめに: 初期実装の決定とプロジェクト構造に関する実用的なガイダンス
第1階層のドキュメントは、実装の詳細に踏み込まずに、各10～20分程度で読めるよう設計されており、しっかりとした基礎を提供します。
02 - 第2階層: 実装
これらのドキュメントでは、ある程度プラットフォームに依存しない実用的な実装パターンを説明します：
- デザインパターン: リポジトリ、プレゼンター、ユースケースなどの一般的なパターン
- 横断的関心事: エラー、ロギング、並行処理などの懸念事項の扱い方
- テスト戦略: 異なるレイヤーとコンポーネントのテストアプローチ
第2階層のドキュメントには、より多くのコード例が含まれていますが、プラットフォーム固有の実装よりもパターンに焦点を当てています。
03 - 第3階層: プラットフォーム固有
これらのセクションでは、プラットフォーム固有の詳細な実装ガイダンスを提供します：
- Swift/iOS: Appleプラットフォームの実装詳細
- Kotlin/Android: Android開発の実装詳細
- その他のプラットフォーム: 利用可能な追加プラットフォームのガイダンス
第3階層のドキュメントには、実際のコード例とコアパターンのプラットフォーム固有の適応が含まれています。
04 - 第4階層: 応用
これらのドキュメントは、経験豊富なPrism Architectureユーザー向けの高度なトピックを扱います：
- パフォーマンス最適化: Prism Architecture実装を最適化するための高度なテクニック
- 複雑な状態管理: 複雑で横断的な状態要件の処理
- エンタープライズパターン: 複数のチームがいる大規模アプリケーションのパターン
第4階層のドキュメントは、前の階層からの概念に精通していることを前提としています。
05 - Prism Lite
小規模プロジェクトや迅速な開発向けのPrism Architectureの簡略版に関するドキュメント：
- 概要とユースケース: Prism Liteを使用する場合
- 実装ガイド: 合理化されたアーキテクチャの実装方法
- アップグレードパス: LiteからフルのPrism Architectureへの移行方法
06 - ジャンプインガイド
特定の側面に焦点を当てたい開発者のための役割別・シナリオ別ガイド：
- 役割ベースのガイド: UI開発者、ドメインエキスパートなどのための特定のガイダンス
- 移行ガイド: 他のアーキテクチャからPrismへの移行方法
07 - サンプル
Prism Architectureを実装した完全なサンプルアプリケーション：
- シンプルなTodoアプリ: コアコンセプトを示す基本的な実装
- Eコマースアプリ: 複数のドメインを持つより複雑な実装
- ソーシャルメディアアプリ: 複雑な関係を持つ高度な実装
08 - リソース
実装をサポートする補助的な資料：
- 図表: 主要概念の視覚的表現
- テンプレート: 新しいプロジェクトやコンポーネントの出発点
- 用語集: 主要用語と概念の定義
推奨学習パス
あなたの役割と経験に応じて、ドキュメントへの異なるアプローチが有益かもしれません：
アーキテクチャ意思決定者向け
- イントロダクションセクションを完全に読む
- 第1階層からアーキテクチャ概要を確認する
- 利点の一覧ドキュメントを確認する
- バランスの取れた視点のために潜在的な批判を確認する
- 実践的な実装を見るためにサンプルを見る
Prism初心者開発者向け
- 「Prism Architectureとは何か？」から始める
- すべての第1階層ドキュメントを順番に読む
- シンプルなTodoアプリの例を確認する
- 直接のニーズに基づいて第2階層ドキュメントを確認する
- 必要に応じてプラットフォーム固有のガイドを参照する
Prismに移行する経験豊富な開発者向け
- アーキテクチャ概要を迅速に確認する
- あなたの背景に関連する移行ガイドに焦点を当てる
- プラットフォーム固有の実装詳細に深く入る
- プロジェクトの課題に関連する高度なトピックを見る
UI重視開発者向け
- アーキテクチャ概要のPresentation Layerセクションを読む
- UI開発者ガイドに焦点を当てる
- 第2階層のPresentation Layerパターンを学ぶ
- 状態管理パターンを調査する
- UI関連のサンプルを確認する
ドメイン重視開発者向け
- アーキテクチャ概要のCore LayerとDomain Layerセクションから始める
- ドメイン専門家ガイドに焦点を当てる
- エンティティ、値オブジェクト、ドメインサービスのドキュメントを学ぶ
- ドメインモデリングの例を確認する
ドキュメント規約
効率的なナビゲーションを支援するために：
- 相互参照: 関連ドキュメントへのリンクが各セクションの最後に提供されています
- コード例: プラットフォーム固有のコードはSwiftまたはKotlinのタグで明確にラベル付けされています
- 図表: 複雑な概念のための視覚的表現が提供されています
- 主要概念: 重要なアイデアはコールアウトボックスでハイライトされています
- 読書時間: 各ドキュメントの冒頭に推定読書時間が提供されています
フィードバックの提供
ドキュメントの改善が必要な領域を見つけた場合：
- ドキュメントプロジェクトのGitHubリポジトリを確認する
- 修正や拡張のために課題またはプルリクエストを提出する
- 実質的なフィードバックは、Prism Architectureチームに直接連絡する