運用手順書づくりで感じた実務経験の大切さ
ほかの手順書を参考にしながら運用手順書を作る中で、実務の経験がいかに大切かを改めて感じました。実際の作業をどれだけイメージできるかで、手順書の質も作成にかかる時間も変わる、という話です。
手順書づくりの続きの話
こんにちは、コマンド学習道場を運営しているこすけです。
前回のコラム「運用手順書を作る側になって感じた大変さと楽しさ」の続きになります。
運用手順書の作成は、今も進行中。
ほかの手順書を参考にしながら書き進めているのですが、その中で改めて感じたことがありました。
それは、実務の経験がとても重要だということです。
ほかの手順書を参考にして気づいたこと
手順書を一から書くのは大変なので、まずはすでにある手順書を参考にするところから。
構成や書き方、確認の入れ方など、参考になる部分はたくさんあります。
ただ、参考にした手順書をそのまま当てはめれば完成、というわけにはいきません。
作業の中身が違えば、必要なコマンドもパスも、確認すべきポイントも変わってくるからです。
そこで必要になるのが、「この作業を実際にやったらどうなるか」を自分の頭で考える力。
ここで実務の経験が効いてくるんだと感じました。
実際の作業をどれだけイメージできるか
手順書を書きながら、実際に作業している場面をどれだけイメージできるか。
今回の手順書づくりで、これがいちばん大事だと感じたポイントです。
たとえば、手順の1行を書くときにも、イメージしたいことはいろいろあります。
このコマンドは、どのユーザーで、どのディレクトリから打つのか。
打ったあとには、どんな出力が返ってくるのか。
その出力のどこを見れば、正しくできたと判断できるのか。
# 3. 設定ファイルが配置されたことを確認する
$ ls -l /path/to/conf/app.conf
# → ファイルが表示されること(No such file or directory にならないこと)
こんなふうに、打ったあとの結果まで思い浮かべられると、手順書に書くべきことが自然と見えてきます。
逆にイメージがあいまいなままだと、何を確認すればいいのかがぼやけてしまい、書いては悩んでの繰り返しになりがち。
イメージできれば、手順書も時間も変わる
実際の作業をしっかりイメージできれば、より良い手順書が作れるはず。
読む人がつまずきそうなところも、先回りして書いておけるからです。
それに、手順書の作成にかかる時間も短縮できると思っています。
手が止まりやすいのは、「ここって実際どうなるんだっけ?」と迷うようなところ。
作業のイメージが頭に入っていれば、その迷いが減るぶん、書くスピードも上がるはずです。
そして、そのイメージの土台になるのが、実務の経験と Linux の知識。
実際に手を動かしたことがある作業ほど、具体的に思い描けるものですよね。
実務と Linux の知見をもっと深めたい
今回の手順書づくりを通して、目標がまたひとつはっきりしました。
実務の経験も、Linux の知見も、もっと深めていきたい。
知識があるからイメージできて、イメージできるから良い手順書が書ける。
その流れを、日々の業務の中で少しずつ太くしていけたらと思っています。
実際の作業を想像する力をつけたい方は、コマンドを打って出力を確かめる経験を増やすのがいちばんの近道。
練習用ターミナルで「打ったら何が返ってくるか」を予想してから実行してみる、というのもおすすめの練習方法ですよ。