ITよろづや

ITの参考になる情報を備忘録代わりに残していきます

サーバーインフラの詳細設計書、環境設計書、パラメータシートの書き方

サーバーインフラの詳細設計書、環境設計書、パラメータシートの書き方について書きたいと思います。これまで色んな現場でサーバーインフラの詳細設計書、環境設計書、パラメータシートを作成してきました。


ちなみに、多くの場合、詳細設計書、環境設計書、パラメータシートは同じものを指すことが多いです。企業によって呼び方が違う場合もあるし、環境設計書がない場合もあります。


今日はその違いというよりは、こういう観点で作成したほうがいいというところを述べたいと思います。


まず、これらの資料は基本的にエクセルで書かれていることが多いです。というのが、設定値などの大項目、中項目などをカテゴリごとに整理しやすいからですね。


例えば、、、以下のようにカテゴリごとにセルで段落を分けて見やすくできます。

・サーバ基本設定
 ・ネットワーク設定
  ・IPアドレス
  ・サブネットマスク
  ・デフォルトゲートウェイ


ワードで記載している現場もありましたが、やはりエクセルが使いやすい印象がありますし、これまでの経験では圧倒的にエクセルを使っていることが多かったです。


そして、エクセルを使うメリットとしては、関数なども駆使できますからね。そして、詳細設計書、環境設計書、パラメータシートを書く上で、重要なポイントになりますが、そもそも、詳細設計書って、サーバの設定値を残すものです。


つまり、サーバを構築した時は、こういった設定をしましたよというものを残すものです。そこでよくある議論ですが、すべての項目があったほうがいいのか。


個人的には設定変更した部分は最低限あったほうがいいと思います。それに関連する項目があればいいかなと思います。


そして、重要なのは、それを設定した根拠です。これがあると、なぜ、それを選択したかの判断を次の担当者が判断できますね。一番やっかいなのは「どうしてこんな設定にしているんだろう?」と思われることです。


どんな理由でもいいですが、しっかりと設定値の根拠があるといいです。例えば、構築の時間がない場合は、「前回踏襲」とか「実績のある値」となるケースがありますが、それをそのままかけばいいのです。


後、これも重要ですが、デフォルト値と変更した場所が分かるように書かれているといいですね。サーバの設定項目を全部網羅している必要はないと思いますが、以下があるといいパラメータシートだなと思います。

・変更した箇所について根拠が書かれている
・デフォルト値が書かれている
・設定の説明があると尚よい


この資料を残す意味はこれを使ってサーバを構築できることなので、手順書とセットでもいいですし、パラメータ自体が手順書という会社もあるでしょう。その分、その資料を使ってサーバが構築できるようになっていればいいと思います。