環境構築手順書の書き方
社内勉強会のネタとして考え始めたけどあまり広がらなかったのでここで開陳。
※我流の環境構築手順です。正しいやり方かどうかは不明。
結論
いきなり結論というか本稿で言いたいことを書くと、
環境構築手順書は環境構築をしながら書こう!
ただ、それだけ。
前提条件
対象としているのは、以下のようなものかなぁ。
- サーバー構築手順
- 開発環境構築手順
- アプリケーションインストール手順
などなど
詳細というかちょっとだけ詳しくいうと
どのタイミングでかく?
⇒本番環境の構築前に必要。
なので試験環境などのスクラップ&ビルドが可能なところで環境構築をしつつ書く。
注意点
・環境構築を実際に作業しながら作る
⇒後で作ると手順がもれるから。
・手順ミスや手戻りも記録する。
⇒ミスや手戻りは記録しておいて、それを解消した手順書を作ってまた環境構築を行う。
こんな感じ。
誰かに教わったわけではないので自信があるわけでもない。
そもそも、当たり前すぎる話なのかな?
とりあえず自分用のまとめくらいの価値はあるねというお話でした。