こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
開発環境情報のテンプレートと例文をご紹介します。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
開発環境情報とは？
開発環境情報はシステム開発時に必要なソフトウェア、ライブラリ、フレームワークなどを一覧化した文書になります。そのプロジェクトにおいて何のソフトウェアやライブラリが使われているのかが一目で把握できます。
昨今、ソフトウェアの開発は素早く、開発中にもバージョンアップしてしまうことがあります。その時々で最新版をインストールしていると、プロジェクトメンバー全体で環境が食い違う状態になるでしょう。開発環境情報を整えておくことで、そうした問題を防げます。
開発環境情報の目的
開発環境情報があることでプロジェクトメンバーの開発環境を同一のものとし、環境によって動作する（または動作しない）といった事態を防げます。また、本番環境の構築時においても開発環境と同じバージョンを利用することで、動作差異を最小限に防げるでしょう。
新しくアサインされたメンバーにおいても、インストール法やバージョンの確認方法が明記されていれば、開発環境を整備するのにかかる時間を軽減できるでしょう。早くアサインできれば、それだけプロジェクトのスムーズな運用が可能になります。
開発環境情報の書き方
開発環境の整え方として、パッケージ管理システムがあって、それを利用するだけであればあえて明記する必要はないでしょう。プロジェクト参加者がそれぞれソフトウェアやライブラリをインストールしなければならない場合は、開発環境情報として明記しておきます。
カテゴリー
OS、プログラミング言語、ミドルウェア、フレームワーク、ソフトウェア、データベース、IDEといった開発に関連するカテゴリーになります。
名称
Windows、PHP、Laravel、MySQLなどといった具体的なソフトウェア名、データベース名になります。
バージョン
各ソフトウェアの利用するバージョンを記します。
確認方法
各ソフトウェアのバージョンを確認する方法を記します。多くの場合、コマンドを実行して確認することになります。この時 --version や -V 、 -v などオプションが異なる場合があるので、あらかじめ調べ方を書いておいてあげると親切です。
インストール方法
各ソフトウェアのインストール方法を記述します。特にバージョンを指定したパッケージをダウンロードするURLがあると便利です。各インストーラーをあらかじめファイルサーバーなどに保存してある場合には、その旨を明記しておきます。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
開発環境情報のサンプル例
| カテゴリー | ソフトウェア名 | バージョン |
|---|---|---|
| プログラミング言語 | PHP | 8.1.2 |
| プログラミング言語 | Node.js | 16.14.0 |
| データベース | MySQL | 8.0.27 |
##確認方法
###PHP
php --version###Node.js
node --version###MySQL
mysql --version##インストール方法
###PHP
https://www.php.net/downloads.php よりOS環境に合わせてダウンロードしてください。
###Node.js
https://nodejs.org/ja/download/ よりOS環境に合わせてダウンロードしてください。
###MySQL
https://dev.mysql.com/downloads/ よりOS環境に合わせてダウンロードしてください。
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/
