1. 設定書とは?現場での役割と目的

設定書の定義

設定書とは、システムやサービスの動作に必要な各種設定項目・手順・バージョン情報を明記した技術文書です。具体的には次のような要素を含みます。

・サーバーOSのバージョン・パッチ

・ミドルウェアの構成(例:Tomcat、MySQL)

・アプリケーション設定ファイルの内容(YAML、properties、ini 等)

・セキュリティ設定(TLS証明書、ポート開放、FWルールなど)

 

なぜ設定書が必要なのか?

 

対象範囲と内容の例

・OS/ネットワーク構成(IP, DNS, ホスト名, SSH鍵)

・Webサーバー(Nginx, Apache)のポート・バーチャルホスト設定

・アプリケーションの設定ファイル(application.yml, .env)

・外部連携情報(APIキー、接続先ホスト、SSL証明書配置先)

 

2. 仕様書とは?その役割と違いを理解する

仕様書の定義

仕様書とは、開発するシステムの機能・動作条件・UI仕様・業務ルールなどをまとめた技術設計ドキュメントです。

・ユーザーの要求を満たすために「何を実現するか」を記述

・UI/UX、画面遷移、入力制御、バリデーションなどを記載

・ソフトウェア開発工程における「上流設計」の柱となる

 

両者の目的・視点の違い

設定書:動かすための環境・構成

仕様書:作るべきシステムの中身・振る舞い

非機能要件にも関わる

仕様書は「動作スピード」「同時接続数」「データ保持期間」などの非機能要件もカバーし、運用設計のベースにもなります。

 

3. 設定書と仕様書の違いを比較表で整理

 

4. 現場で使われる設定書の実例とフォーマット

OS/ネットワーク設定の例

ホスト名:web-server-01

OS:Ubuntu 22.04 LTS

固定IP:192.168.10.101

ポート開放:80, 443, 22

Firewall:ufw allow 80/tcp

タイムゾーン:Asia/Tokyo

 

アプリケーション設定の例(Spring Boot)


 

推奨フォーマット(Markdown/Excel)

 

5. 設定書作成のベストプラクティス

書くタイミング

環境構築直後がベスト。手順をその場でドキュメント化することで正確性が保てます。

 

管理方法

・Gitで設定ファイルと一緒に管理(Infrastructure as Code に近づける)

・Markdown+GitHub WikiやNotionでの社内ナレッジ共有が◎

定期レビュー・見直し

・プロジェクトごとのフォーマット統一

・設定の変更は、必ずレビューと履歴記録を残すこと

・CI/CDによる自動構成(Ansible、Terraform)と連動も推奨

 

6. よくある質問(FAQ)

Q1: 構成管理書と設定書は同じですか?

いいえ。構成管理書はバージョン・構成部品の全体管理で、設定書はその中の構成内容の実体を記録する位置づけです。

 

Q2: 誰が作るのが理想?

構築を担当するインフラエンジニアやSREが作成するのが望ましいですが、アプリ開発者が自分の環境設定を書くこともあります。

 

Q3: フォーマットは自由?

自由ですが、プロジェクトごとにテンプレート統一しておくとチーム内での共有・保守性が向上します。

 

設定書は、OSやミドルウェア、アプリケーションの設定内容を詳細に記録し、環境構築の正確性や障害対応力を高める要となる技術文書です。仕様書とは異なり、「どう動かすか」を明示する実践的な役割を担っており、インフラとアプリ開発の橋渡しとして非常に重要です。記録するだけでなく、更新しやすいフォーマット・運用ルールを整備することで、ドキュメントは組織の資産となります。設定書を「書かされるもの」ではなく、「守れるシステムを作る武器」として活用することが、品質向上とチーム力の強化に直結します。