作業手順書 作成・レビュー 進め方ガイド 新卒・未経験エンジニア向け研修

作業手順書 作成・レビュー 進め方ガイド 新卒・未経験エンジニア向け研修 石黒友季子 / ALJ Education Plus株式会社 「面白きなき世を面白く」 コマンド手順 レビュー チェックリスト 敬語テンプレ

本日のアジェンダ 01 作業手順書とは 02 3つの条件・なぜ必要か 03 コマンド記載の4点セット 何をどの順番で書くか 04 1ステップの正しい書き方 05 レビューの進め方 7ステップ・敬語テンプレ 標準構成（8セクション） NG例 → OK例 よくある間違いと修正方法 06 チェックリスト 作成者・レビュアー用 ALJ Education Plus株式会社 石黒友季子 1

01 作業手順書とは何か 「誰が読んでも・誰が実行しても・同じ結果になるコマンド実行の記録」 再現性 完全性 可読性 誰が実行しても 前提・環境・コマンド 新卒が読んでも 同じ結果になる 確認が全部揃っている 理解できる NG例 NG例 NG例 「適当にやってください」 コマンドだけ書いて 略語・社内用語だらけ 「前回と同じで」 確認手順がない 意味が伝わらない ALJ Education Plus株式会社 石黒友季子 2

02 手順書の標準構成（8セクション） この 8つが揃っていれば、新人は合格です 1 2 3 4 概要・目的 実行環境 前提条件 影響範囲 何をするための手順書か OS・バージョン・権限 実行前に確認すること 何に影響するか 5 6 7 8 手順（本体） 確認手順 ロールバック 問合せ先 コマンドと確認を交互に 実行後に何を確認するか 失敗したときの戻し方 エラー時の連絡先 3・4・7が抜けているとインシデントになります ALJ Education Plus株式会社 石黒友季子 3

03 コマンド記載の4点セット 1ステップ = 目的 ＋ コマンド ＋ 期待する出力 ＋ エラー時の対処 1 目的 何をするステップか一言で 2 コマンド 実際に実行するコマンド STEP 1 sshdの状態を確認する $ sudo systemctl status sshd 期待する出力 active (running) が表示されること エラー時の対処 3 期待する出力 実行後に何が表示されるか 4 failed / inactive → STEP X へ その他のエラー → 作業中断・問合せ先へ連絡 エラー時の対処 何かが起きたらどうするか ALJ Education Plus株式会社 石黒友季子 4

04 よくあるNG例 → OK例 NG例 項目 コマンド記載 service sshd restart 確認手順 （記載なし） エラー対処 エラーが出たら担当に連絡 前提条件 （記載なし） 影響範囲 （記載なし） OK例（修正後） $ sudo systemctl restart sshd $ sudo systemctl status sshd → active(running) を確認 「XXX」が出たら〜を実行 それ以外は担当へ連絡 root権限があること バックアップ取得済みであること SSH接続中のセッションが 一時的に切断される可能性あり ALJ Education Plus株式会社 石黒友季子 5

05 レビューの進め方（7ステップ） 1 2 3 4 5 6 7 作成者 作成者 作成者 レビュアー 作成者 レビュアー 作成者 ドラフト作成 セルフチェック レビュー依頼 内容レビュー 修正対応 最終確認・承認 ドキュメント公開 テンプレに沿って全セ チェックリストで自己 コメントをドキュメン 全コメントに対応また クション記載 レビュー トに記載 は方針を回答 3点を添えて送付 SlackでLGTM Notion等に保存・チー ム共有 お疲れ様です。〇〇です。〜の手順書ドラフトを作成しましたのでレビューをお願いできますでしょうか。 依頼文 ▼ 確認済み：コマンド動作確認済み・全セクション記載済み ▼ 不明点：〜の記載方法が正しいかご確認いただけますか テンプレ お手すきの際にご確認いただけますと幸いです。 ALJ Education Plus株式会社 石黒友季子 6

06 チェックリスト 作成者セルフチェック（提出前） 構成 □ 概要・目的が1〜2行で書かれている 構成 □ 実行環境（OS・権限）が記載されている レビュアーチェックリスト □ 全セクションが揃っているか ○△× □ コマンドは実際に動くか ○△× □ 期待する出力が具体的か ○△× 構成 □ 前提条件が記載されている 構成 □ 影響範囲が記載されている CMD □ 全コマンドの動作確認済み □ エラー対処が実用的か ○△× CMD □ コマンドの前に「目的」が書いてある □ 新卒が手順通りに実行できるか ○△× CMD □ 期待する出力が記載されている □ 影響範囲の記載が適切か ○△× □ ロールバックが実際に使えるか ○△× □ セキュリティ上の問題はないか ○△× CMD □ エラー対処が記載されている 安全 □ ロールバック手順が記載されている 読み □ 読んで声に出して、違和感がないか確認した ALJ Education Plus株式会社 石黒友季子 7

まとめ 01 3条件（再現性・完全性・可読性）が揃っていれば合格 「適当に」「前回と同じ」は最悪の手順書 02 1ステップ = 目的・コマンド・期待する出力・エラー対処 この4点セットを守るだけで品質が大幅に上がる 03 レビュー依頼は「確認済み・不明点」を3点添えて送る 「レビューお願いします」だけはレビュアーに失礼 04 コメントに納得できなくても黙って対応しない 「〜という理由でそのままに」と正直に伝えることが信頼につながる 「面白きなき世を面白く」 石黒友季子 / ALJ Education Plus株式会社