見やすい手順書を書くノウハウ集

コーポレートエンジニアの@sion_cojpです。

コーポレートエンジニアをやってると、コード化できないものも多く、その場合は手順書を残す必要があります。

手順書は 「作業者が、上からなぞって実施していけば誰でも同じ作業になる」ために、見やすく書くノウハウをこの記事では紹介します。

1. 全体の文字数・1文の文字数・画像数をなるべく少なくする

• 感情文字を消す
  • すみません
  • ありがとうございます
• あやふやな文字をなくす
  • と思う
  • 多分
  • したほうがいい
  • 個人的には
  • したい
• 抽象度の高い文字はなくし、具体で書く
  • これ
  • これから
  • ここから
  • この
  • から
• 省略できる文字はなくす
  • 「右上のログインをクリック」→ 「右上のログイン」
• 1文は短くシンプルにする
  • 長い場合は見直しましょう

2. インデントは2つまで。最悪3つ目まで

• これが
  • インデントです
    • ここまでくると書き方・全体設計に違和感がある可能性が高いです

基本的に2つあれば十分です。3つになったら違和感を感じましょう。

3. 危ない作業は赤文字 + 太文字で

4. 画像を使わず、なるべく文字だけで表現する

分かり切った画像は不要です。なるべく文字で表現しましょう。理由はUIは変化していくので、その度対応するとキリがないからです

誤作業が起こりそうな場合は画像を入れましょう

テクニックとして、項目の手順の最後に画像を置くのは、作業者に安心・ひと段落させる意味もあって良いです

5. プロセス図に沿った手順を書く

このケースの場合手順書はこうなります

逆に手順書から、もしプロセス図に落とし込んだら変じゃない？って違和感も大事です

6. 作業の流れだけを書く。ベストはコピペだけでできるように完結させる

• クラウドサイン管理画面 にログイン
  • → 右上の名前
  • → 管理画面に移動
  • → 左サイドバーのメンバー
  • → 右上のメンバーを追加する

みたいな書き方ができると分かりやすいですね

7. 注意点はcalloutに書く

ユースケース: PC発注で「何営業日で出荷され、どれくらいでユーザに届くか」のケースを書く

8. calloutが長くなればtoggleを使う

9. あまり発生しない手順はtoggleを使う

作業のノイズになるものは減らしたほうがいいのが理由です。

10. 分岐を極力少なくする

そもそも分岐をなくせるか検討しましょう。

ユースケース: 例えばPCのスペックを選定する際のキー配列

• Before: MBAのキーボード配列をヒアリングして選択する
• After: JISを選ぶ（プロセスを全員JISに変更する）

11. ひとつの画面で入力することが多い場合は、テーブルを使っていく

• Before
  • 入退社日: 入社手続きリストから入力
  • 分類: 入社
  • 雇用形態: 選択する
  • 対象者氏名: 姓名の半角スペースペース（例: 山田 太郎）
  • 最終出社日: 入力しない
• After

12. できれば各項目に番号をつける

この記事のように、1 ~ 15の項番をつけると良いです。

番号をつける理由は「今どの番号をやってるか把握するため」と「番号をベースに話し合えるようにする」ためです。

もちろんMUSTではなく、運用しやすいように選択すると良いでしょう。

13.コードブロックを有効活用する

ユースケース: Slackでユーザにメッセージを伝える場合

14. 最初の作業で手順書を作る

あとで作るはどうせやらない。もしくは忘れる。気合いで作業しながら作ること。

15. 手順書がない状態が最高

コード化できないので手順書を書く必要があります。

まずはコード化できないか検討しましょう。