いい手順書とは

概要

私が思ういいWebシステム開発における手順書についてまとめる
前提

結論

いい手順書とは下記のような特徴がある

  • 手順に番号が振ってある
    番号が振ってあることで下記のメリットがある
    • 全体を見渡したときに手順がいくつあるかわかる
    • 何番までやったか、何番を実施中か数字で表現できる
  • 手順を実行したかどうか判断できるフィードバックがある
    作業者以外が作業を見たときにどこまでやったかわかる
  • 一つの手順に一つのアクションがある 複数の手順をまとめない
  • 冗長な表現をせず短い文章で書かれている
  • 複数の人間に使われ検証されている
    引き継ぐことを前提とし、複数人が利用する。
    複数人に使われることで手順書の穴が見つかるので、都度修正しブラッシュアップする。
  • 手順以外の情報が書かれていない
    解説や注釈などは別のスペースにまとめる。
    実行するアクションのみ書く。
  • 命令形を使わない
    これは知識が足りずうまく言語化できないが、下記のイメージ。
    • 動詞で終わる例:1. ボタンAを押す
    • 命令形の例:1. ボタンAを押すこと

まとめ

普段なんとなく意識している、自分がいいと思う手順書についてまとめた。
上記のようになっていない手順書をみて結局何をすればいいかわからなかったり、読みづらかったりしたのでまとめた。
手順が多く複雑な場合は自動化を検討したい。

関連情報

下記のエントリに似たような事が書いてあり、方向性が間違ってないことを確認した。 zenn.dev