開発環境構築ガイドの作成

開発者がローカル開発環境を構築できるようにガイドを作成します。

主要な記載内容は以下のとおりです。

  • 前提条件
    • 開発に必要なPCスペック
    • OSのバージョン
  • インストールすべきソフトウェア
    • 入手先
    • バージョン、エディション
  • 特別な設定が必要な場合は設定方法や設定値
    • プロキシの設定など

インストール手順は、公式サイトをみれば十分であるケースがほとんどであるため、 スクリーンショット等の詳細な手順は必ずしも必要ありません。 特殊な手順の有無やプロジェクトメンバーの習熟度等に応じて作成します。

想定される主なソフトウェアは以下のようになります。

項目 プロダクト例
JDK Eclipse Temurin
RDBMS PostgreSQL, Oracle Database
ビルドツール Maven, Gradle
IDE Eclipse, IntelliJ IDEA
バージョン管理ツール Git, SVN
ブラウザ Google Chrome
データモデリングツール SI Object Browser ER

実際のガイドのイメージを以下に示します。

xxxプロジェクト 開発環境構築ガイド

前提条件

開発用PCスペック

必須/推奨 項目 スペック
必須 OS Windows 10 Pro 64bit
必須 CPU Core i7-8550U 以上
必須 メモリ 8GB 以上
推奨 モニタ フルHD 以上
推奨 ディスク SSD

開発環境構築手順

項目 名称 バージョン,エディション等 入手先
JDK Eclipse Temurin OpenJDK 21 https://adoptium.net/temurin/
RDBMS PostgreSQL 16 https://www.postgresql.org/download/windows/

(実案件ではバージョンを固定できるようにガイドすること)
ビルドツール Apache Maven 3.9.9 https://maven.apache.org/
IDE IntelliJ IDEA Community Edition https://www.jetbrains.com/idea/
バージョン管理ツール Git Git for Windows https://gitforwindows.org/
ブラウザ Google Chrome – https://www.google.com/chrome/
データモデリングツール SI Object Browser ER SI Object Browser ER 23 https://products.sint.co.jp/ober/trial

(ライセンスは社内ライセンスを使用)
Officeツール Microsoft Office Microsoft 365 –

(ライセンスは社内ライセンスを使用)