インフラエンジニアのための設計書入門【詳細設計編】〜現場で差が出る「パラメータシート」の作り方とレビューの極意〜

インフラ設計書には、大きく２つの設計書があります。ひとつは、インフラの「方針」や「骨格」を決める「基本設計書」、もうひとつは、システムの詳細なパラメータを記載する詳細設定書です。

今回は、システムの直接的な設計書であり、運用の現場では「正解」として扱われる「詳細設定書」について解説します。現場で必ず通る「ドキュメントレビュー」でチェックされるポイントも合わせて紹介します。

詳細設定書がシステムにおける細かなパラメータや仕様が記載されているドキュメントであるのに対して、基本設計書はシステム全体の方針が記載されています。興味のある方は、以下の記事もチェックしてみてください。

詳細設計の目的「どうやって作るか（How）」を定義する

詳細設計は、基本設計で決めた「冗長化する」「セキュリティを高める」といったシステムの方針を、具体的な「数値（パラメータ）」に落とし込んでいく工程です。

最大の目的は、「誰が作業しても、寸分狂わず同じインフラを構築できるようにすること」です。

詳細設定書（パラメータシート）が正しく作られていれば、構築後のテストもスムーズに進み、将来の障害対応でも「本来あるべき設定値」を確認できます。

【実践】レビューで必ずチェックされる「5つのポイント」

詳細設定書（パラメータシート）を作成すると、必ずチーム内や顧客による「ドキュメントレビュー」が行われます。駆け出しエンジニアが特に指摘されやすい、レビューの視点を紹介します。

① 基本設計との整合性

最も基本的な点ですが、「基本設計で決めた方針とズレていないか」を厳しく見られます。

• 例： 基本設計書で「冗長構成にする」と書いているのに、詳細設定書でインターフェースの設定が1系統しか書かれていない、など。

② 命名規則（ネーミングコンベンション）の統一

ホスト名、VLAN名、プロファイル名などの「名前」には一貫性が必要です。

• チェック項目：
  • 拠点の略称や役割の英単語が統一されているか？
  • 大文字・小文字、ハイフン（-）とアンダースコア（_）が混在していないか？
  • 例： Srv-Web-01 と SERVER_WEB_02 が混在していると、管理が煩雑になるため即座に修正を求められます。

③ 数値の整合性と重複確認

IPアドレスやVLAN IDなどの「値」に間違いがないかを確認します。

• チェック項目：
  • IPアドレスが他の機器と重複していないか？
  • サブネットマスクの計算は正しいか？（/24 なのか /28 なのか）
  • ポート番号やIDが、システムの上限値を超えていないか？

④ 運用・メンテナンス性の考慮

「構築して終わり」ではなく、構築後の「運用」が現実的にできる構成となっているかが見られます。

• チェック項目：
  • 監視用のユーザーや、メンテナンス用の管理ポートの設定が漏れていないか？
  • ログの保存期間やローテーション設定は運用ルールに沿っているか？

⑤ ドキュメントとしての「使いやすさ」

パラメータシートはExcelで作られることが多いですが、その「見やすさ」も品質の一部です。

• チェック項目：
  • フィルターがかかっているか？ ウィンドウ枠の固定はされているか？
  • 変更履歴（誰が、いつ、どこを変えたか）が正しく記載されているか？
  • 構築コマンドをコピー＆ペーストしやすい形式になっているか？

【比較表】基本設計書と詳細設定書の違いまとめ

比較項目	基本設計書	詳細設定書
役割	方針・要件・概要の定義	具体的な設定値（パラメータ）の定義
主な内容	「冗長化する」「クラウドを使う」	「IPは192.168.1.1」「VLAN 10」
主な読者	顧客、PM、アプリ担当者	構築担当者、運用保守担当者
重要視される点	妥当性・実現可能性	正確性・一貫性・網羅性
成果物形式	Word、PowerPoint（構成図）	Excel（パラメータシート）

まとめ：良いインフラは、正確な「数字」から

詳細設定書を作る作業は、地道で非常に細かい作業です。しかし、レビューで指摘されるポイントを意識して作成することで、あなたの設計スキルは飛躍的に向上します。

1. 基本設計書で、揺るぎない「方針」を固める。
2. 詳細設定書で、正確な「数字」と「ルール」に落とし込む。

この2段構えをマスターして、現場で信頼されるインフラエンジニアを目指しましょう。まずは、自分が担当する機器のパラメータを詳細設定書を見ながら、一つずつ、命名規則から丁寧に確認してみてください。

---

インフラエンジニアについて、興味はありませんか。インフラエンジニアの一日の流れに興味のある方は、以下の記事もチェックしてみてください。