はじめに
本記事では、あるプロジェクトで AWSインフラ基盤の基本設計書 を作成した際に、ChatGPTを活用して得られた知見が役立ったため、その内容を紹介します。
特に「設計書の書き方が分からない」「表記や構成で迷う」といった方の参考になれば幸いです。
基本設計書とは?
まず、「基本設計書とは何か?」について、ChatGPTに聞いてみた結果が以下です。
- 要件定義をもとに「どう作るか」を設計する文書
- システム全体の構成・機能・方式を明確にする
- 実装・詳細設計・テスト・運用の土台になる
つまり、基本設計書はプロジェクトの上流工程と下流工程をつなぐ、重要なドキュメントです。
基本設計書のフォーマットと表記ルール
基本設計書を執筆していくうえで、プロジェクトに標準のテンプレートがあればそれを利用しますが、そうでない場合は一から設計書のフォーマットを作成する必要があります。以下では、私が設計書をまとめるうえで意識した表記・構成ルールを紹介します。
1. 用語・表記の統一
項目 | 表記例 | 補足 |
---|---|---|
半角/全角 | 数字・英字・記号は半角、カタカナは全角 | 「10MB」「ユーザー」など |
用語の統一 | 「ログイン」 vs「サインイン」→「ログイン」で統一 | 文書内で統一する |
略語 | 初出時に定義し、以降は略語を使用 | 「SLA:Service Level Agreement」など |
2. 数値・単位のルール
項目 | 表記例 | 補足 |
---|---|---|
数値 | 半角数字を使用、3桁区切り | 例:「1,000件」 |
単位との間 | 半角スペース | 「10 秒」「512 MB」など |
3. 図表・番号付けルール
項目 | 表記例 | 補足 |
---|---|---|
図の番号 | 「図 x-y:タイトル」形式 | 図 3-2:システム構成図 |
表の番号 | 「表 x-y:タイトル」形式 | 表 5-1:データ定義一覧 |
4. フォーマット・構成ルール
項目 | 表記例 | 補足 |
---|---|---|
フォント | 日本語:MS ゴシック、英数字:Arial または Consolas | Wordであればスタイル作成を推奨 |
表の番号 | 「表 x-y:タイトル」形式 | Wordであれば表番号を自動的に割り振ることを推奨 |
基本設計書を執筆する際の注意点
以下の点は、設計書を書く上で気を付けるポイントです。
- 「現行踏襲」という表現は使わない(理由のない設計は避ける)
- ITに詳しくない方でも理解できる言葉で書く
- 長文になりすぎないよう、簡潔に表現する
- 図や表を積極的に活用し、視覚的に分かりやすくする
- 要件定義との乖離がないよう内容を整合させる
- 各項目の設計理由や選定根拠を明記する
AWSインフラ基盤における基本設計書の章構成例
以下は、AWSをベースとしたインフラ基盤における基本設計書の構成例です。
第1章 はじめに
1.1 文書の目的
1.2 対象システム・構成範囲
1.3 対象読者
1.4 用語・略語定義
第2章 システム要件と前提
2.1 システムの非機能要件(可用性・性能・セキュリティなど)
2.2 利用AWSアカウントとリージョンの構成
2.3 運用・保守の前提条件(体制、作業分担など)
第3章 全体構成概要
3.1 インフラ構成図(論理構成図/物理構成図)
3.2 構成概要(利用AWSサービス一覧と役割)
3.3 マルチアカウント戦略(必要に応じて)
3.4 環境構成(開発・検証・本番の区分)
第4章 ネットワーク設計
4.1 VPC設計(CIDR、AZ配置、サブネット分割)
4.2 ルーティング設計(IGW、NAT Gateway、TGWなど)
4.3 セキュリティグループ/NACL設計
4.4 ハイブリッド構成(Direct Connect/VPN)【必要に応じて】
第5章 コンピューティング設計
5.1 使用サービス(EC2/ECS/Lambda 等)
5.2 AMI/Auto Scaling設計
5.3 インスタンスタイプと配置戦略(マルチAZ、耐障害性)
5.4 ロール(IAMインスタンスプロファイル)
第6章 ストレージ設計
6.1 S3バケット構成とライフサイクル設定
6.2 EBS設計(ボリュームタイプ、バックアップ)
6.3 その他ストレージ(EFS、FSxなど)
第7章 データベース設計(必要に応じて)
7.1 RDS/Aurora構成(マルチAZ、リードレプリカなど)
7.2 パラメータ設計(暗号化、パッチ管理)
7.3 DynamoDB/ElastiCacheなどの採用時記載
第8章 セキュリティ設計
8.1 IAM設計(ポリシー、ロール、グループ、最小権限の原則)
8.2 暗号化ポリシー(S3、RDS、KMSなど)
8.3 通信暗号化(HTTPS、TLS、ACM)
8.4 WAF/Shield/GuardDuty等の活用方針
第9章 運用・監視設計
9.1 CloudWatchログ・メトリクス設計
9.2 アラートと通知設計(SNS、Lambda連携)
9.3 バックアップ・リストア設計(RTO/RPO含む)
9.4 障害時対応フローと責任分担
9.5 システム変更・デプロイ方式(IaC、CI/CDなど)
第10章 コスト管理・最適化
10.1 コスト見積もり(AWS Pricing Calculator)
10.2 料金の分割とタグ設計(Cost Allocation Tags)
10.3 RI/SP活用方針とスケーリング設計
10.4 モニタリングとアラート(AWS Budgets)
第11章 セキュリティ・コンプライアンス対応
11.1 AWS Well-Architectedフレームワークへの準拠状況
11.2 監査ログ(CloudTrail、Config、Access Analyzer)
11.3 セキュリティチェックリスト(Security Hub等)
11.4 適用される法令や社内規定(ISO、FISCなど)
第12章 付録・参考資料
12.1 設計判断の根拠と比較検討内容
12.2 詳細構成図(PDF/Visio/Draw.ioなど)
12.3 バージョン履歴・更新記録
12.4 用語集・略語集