読者です 読者をやめる 読者になる 読者になる

うえきのブログ

妙高市に住んでいるサーバエンジニアのブログです

コマンドでの作業をオススメする理由

仕事柄、作業手順書をたくさん書くのですが、コマンドで作業できるものはなるべくコマンドで作業するようにして(もらって)います。GUIの手順書の方が見栄え的にも、知らない人からみた取っ付きやすさ的にも優れているとは思うのですが、コマンドでの作業をオススメするのには理由があります。

手順の再現がしやすい

手順書をみて作業するのが自分自身なら問題はないのですが、その作業に詳しくない人が作業する場合があります。業務移管の場合もあれば、深夜休日にトラブルが発生して電話越しに「とにかくこのコマンドを貼付けて実行してもらえればOK」というケースも結構あったりする(アプリの停止とか、データ取得とか)のでGUIだけでなくコマンドでもできる方法を手順として残しておくようにしています。

それと、作った手順書は一度書き終わった後に環境をまっさらにしてもう一度やり直し、手順に間違いや漏れがないか確認するようにしてるのですが、そんな時マウス操作よりもコマンドの方が確認がやりやすいってのも理由の一つです。

作業ログが残しやすい

作業するときには必ず作業ログを記録するようにしています。TeraTermならtelnetやsshでの作業を簡単に保存できます。最近のバージョンだと行単位で時刻を記録してくれる機能もあります。便利ですね。

他人が行った作業だけでなく自分が作業する場合にも「手順書通りにやったはずなのにうまくいかない」というケースがよくあります。大抵は作業を一つ飛ばしてしまっていたり、入力ミスしてしまったことが原因だったりするのですが、やってる本人は「手順書通りにやった」つもりなわけです。うまくいかなかった原因を調べる時には、まずその手順を疑うことになりますが、その時作業ログが残っていることは重要です。いつ、なにを実行したのか、どれ位時間がかかって、どんな結果が返ってきたのかがすべて記録されていますので原因を特定できる確率がずっと高くなります。

それと「手順書が間違っている」ことも(あってはいけないことなのですが)よくあります。職場で作った手順書だけでなく、製品マニュアルやベンダー作成の手順書でも間違っているケースが経験上多々あります。作業者による「手順書の読み間違え」もあります(root作業を一般ユーザで行っていたとか、その逆とか)。いずれにしても作業ログが残っていれば原因調査は比較的楽になりますのでログは残すように(残しやすいように)しておきましょう。

マウスでの作業でも作業記録が残せればいいんですけど、そういったソフトは聞いたことがありません。なにか良いソフトはないですかね。

手順書を残す手間がかからない

マウス操作を行う手順だと画面キャプチャが必要になる場合が多く、手順書作成に時間がかかってしまいます。キャプチャ画像を貼付けるだけでなくクリックしてもらいたいところを赤丸で囲んだりと色々加工も必要です。手順書作成に時間がかかると手順書を残すこと自体が億劫になってしまい、ついついすっぽかしてしまいがちになります。

コマンドベースで作業ログ、少なくとも実行したコマンドさえ残しておけば、数日後あるいは数ヶ月後に以前に行った作業を再度行うことができます。自分はその日に行った作業を日付付きのフォルダにテキストで保存しているのですが、過去にやったちょっとした作業をもう一度やらなきゃいけない、という時に何度も助かったことがあります。

まとめ

GUIでの操作は初めて操作する際には敷居が低くて良いのですが、繰り返し作業する場合には不向きな場合があります。最近はWebベースのコントロールパネルをブラウザで操作するアプリが増えてきたので、どうしても手順書がマウス操作主体になってしまうのですが、そのアプリの仕組みや用語、作業に慣れてきたら同じことがコマンドでもできないか調べるようにしましょう。


そして作業ログは必ず残すように!


2013-02-16 09:22 追記

作業をコマンドで実行できるようにしておけば、将来的に自動化しやすいってのも理由の一つですね。