コンピューターに関する作業手順書作成について、簡単に考察をする。
特別に人に相談したりしていない。特別参考にした文献はない。そのため、理論があるわけではない。ベストプラクティスではないため、参考にする場合は、注意が必要である。
手順書作成時にどんな順番で、どんな内容を記述するか迷うことがあるため、考察を記録する。
手順書作成時
- 具体的な手順以外、何を書くべきか迷う
- 設定理由が不要・余計な場合もある
- 逆に経緯や理由を一緒に残しておきたい場合もある
- 誰でも出来るようにしたい
- 手順書、成果物が高品質であることは挙げるべきでもない、当たり前のこと
何を書くべきか？
手順書であるため、"具体的な"手順は、もちろん記載すべきである。具体的が重要である。具体的でなければ、ただのメモである。他には、作業手順の見出し、概要が必要となる。 さらに、他人にシェアするという必要を考え、手順の意思、"なぜか"の理由を含めるべきであろう。
記述例
Hyper-Vの仮想ネットワーク作成を例にフォーマットを考えてみる。
[見出し]仮想ネットワークの構築
[方針、内容]内部ネットワークを作る。ネットワーク名はprivateにする。
[理由]ホスト、マシン間で接続可能になる。
[前提条件]
- Hyper-Vが有効であること
[具体的な手順]
new-vmswitch -name private -switchtype internal
[手順の補足]内部ネットワーク(internal)であるが、意図的にネットワーク名をprivateとしている。
[期待値] - マシンから、ホストへpingをしたとき、疎通が出来ること
期待値通りにならない場合は（省略） —-
社会は、ルールを作るだけではよくはならないが、コンピューターはルール、論理の世界。
