手順書の鉄則
ビルド手順書だったり、モジュールの配備手順書だったり、そういった手順書を書くときに気をつけている事を勝手に列挙します。
はじめに
手順書を実施するうえで、最大の敵になるのがヒューマンエラーです。
ヒューマンエラーをなくすには、完全に自動化してしまえばいいんですが、そこまで出来ない場合でも最低限守った方がよい事をのべます。
よくあるパターンが
- コマンドの入力ミス
- 手順を飛ばした
- 配布先を間違えた
などです。
1.手順書の実施順序は最初から最後まで一方向に読めるようにしておく
たとえば、同じ手順を複数の箇所で実施させる場合、
ここでXXページの○○手順を実施する。
などといった前の手順に戻って実施させるような記述は避けましょう。
途中で手順をさかのぼって実施させると、いまどこの手順を実施しているのか分からなくなり、ある手順がスキップされてしまう確率が上がります。
めんどうですが、コピーペーストで同じ手順をコピーしておきましょう。また、手順に変更が合った場合に修正するのを忘れないでください。
場合によっては途中の手順をスキップするように記述してもよいですが、その場合はどのような場合にスキップしても良いか、条件を明確にしておきましょう。
2.実行した手順の結果を確認する。
たとえば、ファイルをコピーしたら、コピー先の内容を確認する。
コマンドを実行したら、エラーが出ていないかコマンドの実行結果を確認する。
問題が起きたのに気づかないまま手順書の実施を進めないようにするためです。
3.手順、確認項目、パラメタを省略しない
面倒でも、手順や確認する項目、コマンドパラメタなどを省略してはいけません。
省略したところにヒューマンエラーが潜んでいるものと思ってください。
4.GUIでの操作を極力避ける
ミスしやすいため避けましょう。（エクスプローラで、ファイルがどっかに行ってしまったことはありませんか？）
あと、手順書からのコピペで実行できないのでとても面倒です。
コマンドの実行で代替できるなら、そちらを優先して使いましょう。
ファイルのコピーなどはバッチファイル化すると良いでしょう。
5.キーボードからの手入力は極力避ける
ミスしやすいため避けましょう。
手順書にコマンドやパラメタを記述しておき、それをコピーペーストして実行できるようにしておいた方が無難です。
