インフラエンジニアのドキュメント作成術|設計書・手順書・障害報告書の書き方と管理方法

現場実践|インフラ設計書・手順書作成
インフラエンジニアのドキュメント作成術|設計書・手順書・障害報告書の書き方と管理方法
「インフラ設計書ってどう書けばいい?」「手順書の書き方にルールはあるの?」——インフラエンジニアが現場で必ず書く設計書・手順書・障害報告書の構成・書き方のポイント・効率的な管理方法を解説します。
💡 インフラエンジニアのドキュメント力はスキルと同等に評価されます。「設計意図が伝わる設計書」「誰でも作業できる手順書」「再発防止につながる障害報告書」を書けることが現場での信頼につながります。
1. 設計書(基本設計・詳細設計)の書き方
基本設計書に含める内容
システム全体像(構成図)・サブネット設計・セキュリティ設計・冗長構成・バックアップ設計・監視設計。「なぜこの設計を選んだか」の設計根拠を必ず書く。
詳細設計書に含める内容
各リソースのスペック詳細(インスタンスタイプ・CIDR・セキュリティグループルール等)・パラメータ設定値・設定の根拠。Excelではなくドキュメントベースのマークダウンを推奨。
2. 手順書の書き方(誰でも作業できるレベル)
1
作業の前提条件・必要権限を明記する
「この手順を実施する前にAWSコンソールに管理者権限でログインしていること」のような前提条件を最初に書く。
2
コマンドはコピーして実行できる形式で書く
「<インスタンスID>を入れる」ではなく「aws ec2 describe-instances –instance-ids i-XXXXXXXXXXXXXXXXX」のように変数部分が明確な形式で書く。
3
期待される結果(スクリーンショット・出力例)を入れる
各ステップの後に「正常に完了した場合の出力例」を入れることで、作業者が「正しくできているか」を確認できるようにする。
4
ロールバック手順を必ず書く
「作業に失敗した場合・想定外の事象が発生した場合は以下の手順で元の状態に戻す」というロールバック手順を最後に必ず書く。
3. 障害報告書(ポストモーテム)の書き方
- タイムライン:「○時○分 アラート発報」「○時○分 担当者が認知」「○時○分 原因特定」「○時○分 復旧完了」という時系列で事実を記録する
- 根本原因(Root Cause):「何が起きたか」ではなく「なぜ起きたか」を5 Whysで深掘りする
- 再発防止策:「誰が・いつまでに・何をするか」が明確な具体的なアクションアイテムを設定する
- ブレームレス(責任追及なし):特定の個人を責めるのではなくシステム・プロセスの問題として分析する
📌 この記事のポイント
- 設計書は構成図・設計根拠・パラメータ詳細の3点セットが必須。「なぜこの設計か」を必ず書く
- 手順書は前提条件・コピー可能なコマンド・期待出力・ロールバック手順の4点セットで誰でも作業できる
- ポストモーテムはタイムライン・根本原因・再発防止策・ブレームレスの4原則で書く
キャリアの疑問、一緒に解決しませんか?
Route Bloomでは、インフラ系ITエンジニアを目指す方への個別サポートを行っています。2026年7月からフリーランス講師として本格始動予定です。
ABOUT ME




