Skip to content

プロジェクトドキュメント

プロジェクトで管理しているドキュメントの入口です。

まずこれを読もうリスト

  • 戦略 - ビジネス構造やプロジェクトの方向性を整理します。
  • 要件 - RDRA 2.0 ベースで要件を定義します。
  • 設計 - アーキテクチャ、モデル、品質方針を整理します。
  • 開発 - リリース計画とイテレーション管理の入口です。
  • 運用 - 環境構築、デプロイ、運用関連の入口です。
  • 記事 - 学習用の記事シリーズの入口です。

ドキュメント構成

カテゴリ 概要 状況
戦略 ビジネスアーキテクチャ、インセプションデッキの整理 2 件作成済み
要件 RDRA 2.0 とユースケース整理の入口 4 件作成済み
設計 アーキテクチャ、モデル、テスト、非機能の整理 10 件作成済み
開発 リリース計画、イテレーション計画、進捗管理 index.md を整備済み
運用 環境構築、デプロイ、運用手順の整理 2 件作成済み
レビュー 分析・開発レビュー結果の記録 1 件作成済み
ADR Architecture Decision Records の管理 6 件作成済み
記事 学習用の記事シリーズ一覧 index.md を整備済み
リファレンス 開発ガイドラインやベストプラクティス 28 件のドキュメントを配置
テンプレート 各種ドキュメントの作成テンプレート 16 件のテンプレートを配置

戦略ドキュメント

ドキュメント 概要
ビジネスアーキテクチャ ビジネスモデル・バリューストリーム・ケイパビリティ・ビジネスシナリオ
インセプションデッキ プロジェクトの目的・スコープ・リスク・ロードマップ(10 の問い)

要件定義ドキュメント

ドキュメント 概要
要件定義書 RDRA 2.0 に基づく 4 層(システム価値・外部環境・境界・内部構造)
ビジネスユースケース 業務レベル BUC 13 件・アクター目的リスト
システムユースケース システム境界 UC 12 件(完全形式)
ユーザーストーリー US 18 件・受け入れ基準・トレーサビリティマトリックス

設計ドキュメント

ドキュメント 概要
バックエンドアーキテクチャ DDD + ヘキサゴナル + CQRS、Spring Boot 4、6 コンテキスト
フロントエンドアーキテクチャ Thymeleaf SSR + htmx、Bootstrap 5、画面遷移設計
インフラストラクチャ AWS ECS/RDS、Docker、GitHub Actions CI/CD
データモデル設計 概念・論理データモデル、テーブル定義(16 テーブル)、ER 図
ドメインモデル設計 6 コンテキスト、集約・エンティティ・値オブジェクト・ドメインイベント
UI 設計 画面一覧・画面遷移図・ワイヤーフレーム・インタラクション設計(17 画面)
テスト戦略 ピラミッド型テスト、ツール選定、カバレッジ目標
非機能要件 性能、可用性、セキュリティ、保守性、拡張性(ISO/IEC 25010 準拠)
運用要件 監視、バックアップ、デプロイ、障害対応
技術スタック選定 バックエンド・フロントエンド・インフラ・テスト全技術スタック一覧

運用ドキュメント

ドキュメント 概要
アプリケーション開発環境セットアップ ローカルアプリケーション開発環境の構築手順
開発環境セットアップ Heroku コンテナを使った開発環境の構築手順

ADR

ドキュメント 概要
ADR-001 Java 25 LTS / Spring Boot 4.0 採用と移行ロードマップ
ADR-002 ドメインイベントに @TransactionalEventListener(AFTER_COMMIT) を使用
ADR-003 DiscountPolicy をエンティティとして設計
ADR-004 荷主セルフサービス機能を Phase 1 スコープ外
ADR-005 Windows Docker Desktop での Testcontainers 接続設定
ADR-006 Spring Boot 4 開発環境での H2 Console 設定

レビュードキュメント

ドキュメント 概要
ドメインモデル分析レビュー ドメインモデル分析のマルチパースペクティブレビュー結果(高 11 件・中 12 件・低 5 件)

補足

  • strategy/requirements/design/development/operation/ は現時点ではカテゴリ索引が中心です。
  • journal/ は作業ログ用の予約ディレクトリです。
  • assets/ は MkDocs 用のスタイル・スクリプトを格納しています。