はじめに
皆さんこんにちは新卒一年目でヒイヒイ言いながら毎日業務を行ってるしがないエンジニアです。
今回は、実際に現場で手順書を大量に現行のものを次期用に改修する事があったので、その際に私が気を付けた点を自分でも思い出せるように備忘録として紹介していきます。当たり前の事がほとんどですが、意外と出来ていない手順書・・・多いんですよ。
最初のうちに全体を把握する
まず初めはやっぱり全体を把握することです。（当たり前かもですが・・・）
ある程度どの部分の修正が必要か、見難い部分がどの部分か全体を把握する事によって所要時間やこの作業はどんな事を行っているか理解することが出来ます。
実際に私も全く初見だった作業の手順書の修正タスクを振られた際にどんな事を行っているかさっぱり分かりませんでした。しかし、全体をはじめのうちに把握することによって、ある程度その作業に対する知識が付くので修正もしやすかったです。
Wordの機能「目次」は絶対使用する
これも知ってる人は結構居ると思います。
実は私は現場に入ってから初めてこの便利機能を知りましたw
分からない人も居るかもなので、簡単に説明すると・・・
Word の目次作成機能を使うことで、手動で目次のフォーマットを編集したり、自動で文章の見出しから目次を作成したりできます。（以下テスト用Wordファイル）
更にカーソルを飛びたい項目名に合わせて「Ctrl」を押しながら左クリックすると、その項目のページまで飛ぶことができるんです！
これ知ったときは「すげぇ！！」って感心してしまいましたw
これが設定されてる手順書を作ることができれば「シゴデキ」と思われるに違いありません！そうじゃなくてもページ数が多い手順書でもこの目次機能を使えば自分が求めている情報を素早く取得でき、業務効率がかなり上がると思います。
設定方法などは以下のサイトを御覧ください！
Word で簡単に目次を作成! 更新、リンクなどの機能と使い方を解説
改行の仕方は注意する
これは学生の頃にも教授に指摘されて意識し始めたポイントです。
画像について説明をしているのにその画像が次のページにあると、画像を見るためには次のページに行かないと行けないのでとても読みにくいです。必ず画像とその画像についての説明はセットで１ページに収められるように、画像の大きさや文章の区切り方などを工夫しましょう。
ダメな例 次のページに画像が載ってしまってる
良い例 説明文と同じページに画像が載っている
画像は多い方がわかりやすい
「説明文は多いのに画像が一個もなくてそのボタンどこにあるか分からない！」なんてことありませんか？
私はめっちゃありましたw
文章だけだと以下のデメリットがあると思います。
・どこの画面を指しているか
・どのボタンを押すのか
・どう表示されているのが正しい状態かが文字だけだと伝わりづらい
・文章を読んで画面と照らし合わせる必要があり、理解に時間がかかる
しかし画像が多い手順書だと以下のようなメリットがあると思うんです。
・実際の画面や操作箇所が画像で示されているため、迷いが少ない
・画像があることで間違った画面やボタンを選びにくい
・文章を読む量が減り、視覚的に流れが掴みやすい
・見たままの操作ができるのでハードルが低い
操作方法は細かく・・・でも簡潔に
画像だけを載せる・・・はもちろんダメです。
その画像についてどういうことなのか、画像のどの部分を選択してどう進めればいいか、短すぎず・長すぎず適切な文章量でまとめる事が大切です。
その他のポイント
その他にも様々なポイントがあります。
・一文を長くしすぎない
・注意ポイントは赤色文字を使用する
・省略を使う際は必ず注意書きを入れる
などなど・・・初歩的ですがかなり大切だと実感しました。
さいごに
以上が特に私が意識してる部分です。
当たり前の事ばかりですが、実際には出来ていない手順書もたくさんありますので、この備忘録を参考に素晴らしい手順書を書いていただけたらなと思います。