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

treedown’s Report

システム管理者に巻き起こる様々な事象を読者の貴方へ報告するブログです。会社でも家庭でも"システム"に携わるすべての方の共感を目指しています。

自分用マニュアルを作ろうと思った時

運用管理 私流方法論

仕事柄、よく作業手順書を作ります。構築したメールサーバを使うためのメーラ設定手順とか。
今日はこのマニュアルを作る、という基準についてご報告します。

マニュアルを作るのはなぜか

簡単に言えば、「前提となる知識をなしにして、欲しい結果を得るため」となります。
メールサーバを使うためのメーラ設定はメールサーバ名やポート番号、暗号化方式、認証方法と認証のためのIDを入力する必要があり、それはメールサーバによって設定する項目こそ変わらないものの、様々な設定の表記方法があります。
しかし、いちいち「このメールサーバは暗号化としてTLSを使っていまして…。」と説明するわけにもいきませんし、メールを使う側としてもメールサーバとメーラの間でどのような暗号化方式が使われているか、という点は大して興味がありません。どうすればメールが使えるようになるか、という点が興味の対象です。

ここのギャップを埋めるため、必要な情報を必要な分だけ使う人に伝えるために必要に迫れられて「マニュアルを作ろう」となります。
概ねこの状況になるとマニュアルを用意することが多いです。
難しく言えば、
「自分以外の人に自分が時間を掛けて獲得した知識を習得する時間をすっ飛ばして、同じ結果を出してもらうようにする」
といったところでしょうか。

それでも最初は作らない

それでも最初は手順書を作らないことも多いです。
と、いうのも手順書を作るのは結構な労力になるのです。作らない人にとっては「あーなんかメールに添付されてたヤツね。まだ見てない。」などと悲しいことを言われることもしばしばです。
そういう時は作り笑いをしながら「あー、そうですよね~。」と適当に相槌打っておくのが無難ですね。

ドキュメント作成って、重要なことや仕事のノウハウなどを織り交ぜて結構な労力が掛けなければ作成できない割に、肝心の読んで欲しい人は読んでくれないことも多いんですよね。だったら自分でその作業やった方がいいや、ってなることも…あるあるですね。
挙句、ドキュメント読まずに
「作業全然わかんないんですよねー。これ難しすぎでしょー。(失笑)」
なんて言われることだってあります。愚痴です。ええ愚痴ですとも。

未来の自分向け

それでも労力を割いてドキュメントを残すことがあります。
同じことが三回、四回と続くことで、その作業・その手順は今の業務で必要だ、ということになるからです。
ドキュメントが悲しい結末を迎える可能性が高いとしても、敢えてドキュメントを残す意図のもう一つは、表題にある「未来の自分に向けて」です。

実際手順は忙しい毎日の中で記憶が廃れていくことだってあります。日常業務で毎日やっている手順ならそういうこともありませんが、一カ月に一回とか年に一回しかないような更新作業は忙しければ忙しいほど別の記憶で上書きされてしまうことが多く、未来の自分が今日無事に完了させたことを同じように完了させられる自信が私にはありません。

そこで自分用作業手順書です。自分が理解できる程度に作業手順書を作成します。自分が理解できないようならかなり細かく画面キャプチャして手順書を作成します。
あとはその作業手順書の保管場所さえ忘れなければ、幾重にも重なる作業手順は忘れてもOK、ということになります。なにせ自分が自分のために自分用作業手順書を作っているのですから。

究極は自動化

手作業でコツコツやってることがコンピュータの中で完結して、トリガを補足してコンピュータが勝手に完了させてくれるのなら、それに越したことはありません。
ただ、それとて、作業を自動化するために、どのようなステップでコンピュータに必要な処理を漏れなく実行させるか、をよくよく調べ上げてタスクなりスケジュールなりを作らなきゃいけません。実はこのとき役に立つのが「自分用作業手順書」です。
実は自分用作業手順書を作成していくと、普段から技術的な情報収集をしていくうちに「あれ?これってあの作業に使えるんじゃ…?」というブレイクスルーのきっかけを得ることがあります。

自分用作業手順書がバッチファイルなりシェルスクリプトなりで自動化するときに必要な、処理のステップ・流れをある程度把握するのに役立ってくれます。しかも作成すると頭の中まで整理されるというおまけ付き。
自分用作業手順書を完成させた時には自動化できないと思っていても、しばらくクールダウンしてある日見返してみると、何か自動化できそうだな…という雰囲気を醸し出していることもあるから不思議なものです。

もし思い立ったら…

実は日の目を見る前に役に立たなくなったドキュメントも数多くありますが…
それでも、もし、職場で自分しかやっていない作業があって…

  • 奇跡的に10分や15分程度時間が空いたとしたら、
  • 月例作業をやろうとしたときに「今月は画面キャプチャだけ取ってみようかな」と思ったら、

ぜひ、やってみようと思った時に一度画面取りだけでもやってみると、新しい発見があるかもしれません。それが、もしかすると未来に役に立つ情報になってくれるかもしれません。