LESSON 30分

手順書の重要性

ストーリー

「デプロイってどうやるんですか？」

「え？前に教えたよね？」

「すみません、メモを取ってなくて...」

「手順書があれば、何度も聞かなくても自分でできるようになるよ。今日は手順書の書き方を学ぼう」

手順書とは

手順書とは、特定の作業を完了するための具体的な手順を記載した文書です。

手順書の例:
- デプロイ手順書
- 環境構築手順書
- バックアップ/リストア手順書
- 障害対応手順書
- アカウント作成手順書

なぜ手順書が重要なのか

1. 誰がやっても同じ結果になる

手順書がないと、作業者によって結果がバラバラになります。

手順書がない場合:
  Aさん: 「なんとなくこんな感じで...」→ うまくいった
  Bさん: 「えーと、どうやるんだっけ...」→ 失敗した
  Cさん: 「Aさんに聞こう」→ Aさんの時間を奪う

手順書がある場合:
  Aさん: 手順書通りに実行 → 成功
  Bさん: 手順書通りに実行 → 成功
  Cさん: 手順書通りに実行 → 成功

2. 属人化を防ぐ

属人化とは:
「Aさんしかできない」「Bさんがいないと分からない」という状態

問題点:
- Aさんが休むと作業が止まる
- Aさんが退職すると知識が失われる
- Aさんに負担が集中する

解決策:
- 手順書を作成し、誰でもできるようにする

3. ミスを防ぐ

人間の記憶は不完全です。手順書があれば、手順の抜け漏れを防げます。

シナリオ手順書なし手順書あり
慣れた作業「いつも通り」で1手順忘れるチェックしながら確実に実行
久しぶりの作業「あれ、どうだっけ」で迷う手順書を見れば迷わない
深夜の緊急対応焦ってミスする手順書で冷静に対応

4. 教育コストを下げる

手順書がない場合:
  新人「デプロイ方法を教えてください」
  先輩（1時間かけて説明）

  新人B「デプロイ方法を教えてください」
  先輩（また1時間かけて説明）→ 合計2時間消費

手順書がある場合:
  新人「デプロイ方法を教えてください」
  先輩「この手順書を見てやってみて。わからなければ聞いて」

  新人B「デプロイ方法を教えてください」
  先輩「同じ手順書を見てね」→ 説明時間ほぼゼロ

良い手順書の特徴

1. 前提条件が明確

markdown
## 前提条件
- Node.js 18以上がインストールされていること
- AWS CLI が設定済みであること
- 管理者権限を持つアカウントでログインしていること

2. 手順が具体的

markdown
悪い例:
1. 設定を変更する
2. デプロイする

良い例:
1. config.json の "environment" を "production" に変更する
2. ターミナルで `npm run deploy` を実行する

3. コマンドがコピペできる

markdown
悪い例:
サーバーにSSH接続してください。

良い例:
以下のコマンドでサーバーにSSH接続します:
```bash
ssh -i ~/.ssh/mykey.pem ec2-user@12.34.56.78

### 4. 確認ポイントがある

```markdown
3. デプロイコマンドを実行する
   ```bash
   npm run deploy
  1. 【確認】以下のメッセージが表示されることを確認する 
    Deploy completed successfully.
    ※ エラーが出た場合は「トラブルシューティング」を参照

### 5. トラブルシューティングがある

```markdown
## トラブルシューティング

### エラー: "Permission denied"
原因: 実行権限がありません
対処: `chmod +x deploy.sh` を実行してから再度試してください

### エラー: "Connection refused"
原因: サーバーが起動していません
対処: AWSコンソールでインスタンスの状態を確認してください

手順書の基本構成

markdown
# [作業名] 手順書

## 概要
この手順書は○○を行うための手順です。

## 前提条件
- 条件1
- 条件2

## 作業時間の目安
約30分

## 手順

### 1. [最初のステップ]
実行するコマンドや操作

【確認】期待される結果

### 2. [次のステップ]
...

## 完了確認
- [ ] 確認項目1
- [ ] 確認項目2

## トラブルシューティング
### よくあるエラー1
...

## 関連ドキュメント
- [リンク1]
- [リンク2]

手順書を書くタイミング

タイミング理由
初めて作業を行ったとき手順を忘れないうちに記録
2回目に同じ作業をしたとき再利用の価値があると判明
他の人に作業を教えるとき説明を文書化すると効率的
手順を改善したとき改善内容を反映

「2回以上やる作業は手順書を作る」がベストプラクティス

まとめ

ポイント内容
手順書とは特定の作業を完了するための具体的な手順を記載した文書
重要な理由誰がやっても同じ結果、属人化防止、ミス防止、教育コスト削減
良い手順書前提条件明確、具体的な手順、コピペ可能、確認ポイント、トラブルシューティング

チェックリスト

  • 手順書の目的と重要性を理解した
  • 良い手順書の特徴を5つ挙げられる
  • 手順書を書くべきタイミングを理解した

次のステップへ

手順書の重要性は理解できましたか？

次のセクションでは、手順書の読み方について学びます。 まずは他の人が書いた手順書を正しく読み解けるようになりましょう。

推定読了時間: 30分