マニュアル(手順書)っている?

スポンサーリンク

マニュアルや手順書の必要性ってあまり感じないんですよね。

マニュアルを作る人にとってはすごく意味のある事だと思うのですが、作業者が読むためのマニュアルに対しては必要性が感じられないのです。

今回は僕がマニュアルの必要性を感じない理由をご説明します。

ここで説明するマニュアルとは社内エンジニア向けに作成するマニュアルのことを言います。

スポンサーリンク

マニュアルが不必要と考える理由

作業者が本質を理解してくれない

作業の目的を意識してくれればいいのですが、ただマニュアルに書かれていることに従って作業する方がいます。

このような考えで作業をすると、書かれていることしかできないためイレギュラーな事象に対応できないことが多いのです。

つまり、マニュアルがないと作業ができないのです。

一方でマニュアルを作成する側は試行錯誤を繰り返しているため、イレギュラーな事象にも対応ができます。

マニュアルを作ることで、作成者の頭が整理されることは事実ですが、作業者はマニュアルがないと作業ができない環境になってしまう可能性があるのです。

調べるよりも先にマニュアル作成者に聞いてくる

僕の書き方にも問題があるのですが、マニュアルを作成する場合、基礎知識についは書きません。

例えば、「どこどこのWEBサーバーへ接続」とは書きますが、マニュアルの作成に時間をかけたくないため、接続の仕方は書きません。

知らないことが悪いって訳ではありませんが、SSHツールのダウンロード方法や接続方法までの説明は書きたくないのです。

基礎知識部分で分からない場合は一度調べてみましょう。同じマニュアルを渡しても調べてやってくれる人と全て聞いてくる人では2度目の作業の時に差が出てきます。

最低限の知識はせめて調べてから着手してほしいのです。

結局ミスる

凄く細かくマニュアルを作ったことがあるんですが、ちゃんと読んでくれないことが多いんですよねw

細かくなると手順が多くなるため、作業者は設定ミスをしたり、コマンドの順番を飛ばしちゃって最終的に使い物にならない成果物が出来上がります。

完璧に近いマニュアルは思考停止して作業する人が多いため、単純なミスが増えます。

そして後処理はマニュアルを作った人、または過去に試行錯誤したナレッジを持っている人になります。

マニュアルがあっても作業者が人間だとミスは必ず起こります。

手順書作成はいらないけれど作業記録は大事ですよ

マニュアルは要らないってことを挙げてきましたが、作業記録は大事です。

だって、同じ会社の人間が同じことで悩むなんて凄く馬鹿らしいじゃないですか。

だから僕はマニュアルではなく、作業記録を残します。

サーバー構築の場合で例えると、インストールしたパッケージやバージョン、設定した値や、ハマった(注意する)ところを残します。

初めてのメンテナンス作業の場合は、この作業を行ったときの考えや行ったことを残します。

これがあるだけでエンジニアが行うには十分な手順書になると思います。

いちいち体裁を整えたり、色付けたりキャプチャとったりとかそんなことやっている時間があったら他のことに使いものです。

ましてや、細かすぎるとマニュアルのメンテナンスにもコストがかかります。

作るのにも、変更するのにも時間をかけてしまうと本末転倒だと思うんですよね。

マニュアルに沿って作業するときに気を付けていること

マニュアルが存在する作業の場合はマニュアルを参考に作業します。

その時に気を付けていることは作業の目的を理解し、一度脳内で実行することです。

すぐに着手したい気持ちもわかりますが、一旦落ち着きましょう。

まずは作業の目的を理解し、ゴールを決めます。

次にマニュアルに目を通して、作業全体の流れをつかみ、一度脳内で実行してみましょう。

自分の知っている範囲で間違いないか、オプション付けまくりのコマンドがないかなど確認しましょう。

わからないコマンドは何をするコマンドなのかググってください。

問題なければ、マニュアルに沿って作業してください。

時々マニュアルが間違っていてミスすることもありますが、実行前に防げることがほとんどです。

マニュアルが間違っていても実行するのは自分なので、考えながらとりかかるように僕は意識しています。

タイトルとURLをコピーしました