refactoring

Author: KTC-YoheiMiyashita

README.ja.md

@@ -11,6 +11,13 @@
 
 🇬🇧 英語版のREADMEは[こちら](README.md)
 
+## 📋 必要要件
+- JDK 21（Gradleのツールチェーンで自動的にダウンロード）
+- Docker Desktop
+- Gradle 8.5以上（gradlewを使用する場合は不要）
+
+> 💡 このプロジェクトはJDK 21を使用しますが、Gradleのツールチェーン機能により、ローカル環境にJDK 21がインストールされていなくても自動的に必要なJDKがダウンロードされます。
+
 ## 🔍 概要
 
 このリポジトリは**Spring Boot 3**と**Spring Batch 5**に特化した、エンタープライズ向けバッチ処理アプリケーションの基盤となるスターターキットです。業界のベストプラクティスを取り入れ、最新のSpringフレームワーク機能を活用してバッチ開発プロセスを加速します。
@@ -49,6 +56,23 @@
 - CI/CD統合: GitHub Actionsワークフロー搭載
 - シンプルなビルドプロセス: 本番対応JARを生成するシングルコマンドビルド
 
+## 📌 バージョン情報
+- Spring Boot: 3.4.1
+- Spring Dependency Management: 1.1.7
+- Spotless (Google Java Format): 6.22.0
+- jOOQ: 9.0
+- OpenCSV: 5.9
+- SpotBugs: 6.0.27
+
+### 使用プラグイン
+- spring-boot
+- spring-dependency-management
+- spotless
+- jooq
+- jacoco
+- spotbugs
+- project-report
+
 ---
 
 ## 📁 プロジェクト構造
@@ -115,6 +139,17 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spr
 
 > **注意**: 	データベースセットアップにはDockerのインストールが必要です。
 
+## 🔧 トラブルシューティング
+### よくある問題
+
+#### 1. Entityクラスが見つからない
+   - 原因: jOOQによる自動生成が未実行
+   - 解決: ./gradlew buildを実行
+
+#### 2. データベース接続エラー
+   - 原因: MySQLコンテナが未起動
+   - 解決: docker compose up -dを実行
+
 ## ♻️ カスタマイズ性
 このスターターキットは簡単なカスタマイズを想定して設計されています。データベース設定とCSVマッピングを特定の要件に合わせて変更するだけで、すぐにビジネスデータの処理を開始できます。
 

README.md

@@ -11,6 +11,13 @@
 ## 🌐 Language Support
 🇯🇵 日本語版 README は [こちら](README.ja.md).
 
+## 📋 Requirements
+- JDK 21 (automatically downloaded by Gradle toolchain)
+- Docker Desktop
+- Gradle 8.5+ (not required if using gradlew)
+
+> 💡 This project uses JDK 21, but thanks to Gradle's toolchain feature, it will be automatically downloaded even if not installed locally.
+
 ## 🔍 Overview
 
 This comprehensive starter kit is designed specifically for **Spring Boot 3** and **Spring Batch 5**, offering a production-ready foundation for enterprise batch processing applications. It incorporates industry best practices and leverages the latest Spring framework features to accelerate your batch development process.
@@ -49,6 +56,23 @@ This comprehensive starter kit is designed specifically for **Spring Boot 3** an
 - **CI/CD Integration**: GitHub Actions workflows included
 - **Simplified Build Process**: Single-command builds generating production-ready JARs
 
+## 📌 Version Information
+- Spring Boot: 3.4.1
+- Spring Dependency Management: 1.1.7
+- Spotless (Google Java Format): 6.22.0
+- jOOQ: 9.0
+- OpenCSV: 5.9
+- SpotBugs: 6.0.27
+
+### Plugins
+- spring-boot
+- spring-dependency-management
+- spotless
+- jooq
+- jacoco
+- spotbugs
+- project-report
+
 ---
 
 ## 📁 Project Structure
@@ -115,6 +139,17 @@ java -jar build/libs/dbAndCsvBatch-*.jar --spring.batch.job.name=CSV_TO_DB --spr
 
 > **Note**: Docker installation is required for database setup.
 
+## 🔧 Troubleshooting
+
+### Common Issues
+#### 1. Entity classes not found
+   - Cause: jOOQ auto-generation not executed
+   - Solution: Run `./gradlew build`
+
+#### 2. Database connection error
+   - Cause: MySQL container not running
+   - Solution: Run `docker compose up -d`
+
 ## ♻️ Adaptability
 The starter kit is designed for easy customization. Simply modify the database configurations and CSV mappings to align with your specific requirements, and you're ready to start processing your business data.