技術力以前の壁。誰が読んでも迷わない「手順書」を書くための3つの鉄則

はじめに

「手順書を読んでも、結局どこを操作すればいいか分からない……」
「自分で書いた資料を先輩に見せたら、『意味が通じない』と突き返された」

インフラエンジニアの仕事の半分は、実は「文章」です。特にSESでは、現場が変わるたびに大量のドキュメントを読み、また自分の作業を後に残す必要があります。

はじめまして、ハンズオンラボ運営メンバーの「えむ」です。
私は6年間のエンジニア生活の中で、数多くの「解読不能な手順書」に泣かされてきました。その経験から気づいたのは、良い資料を作るのに「高度な技術力」は不要だということです。

今回は、現場で「えむさんの資料は分かりやすいね」と信頼されるための、文章のコツをお伝えします。

以前、先輩が書いた「設定を確認し、反映する」という1行の手順で、私はパニックになりました。「どの画面で？」「何の設定を？」「反映って、サービス再起動が必要なの？」……。

書いた本人には「当たり前」の前提条件が、読む側には全く伝わっていないからです。これが作業ミスや事故の引き金になります。

私は、すべての手順に**【誰が・どこで・何を・どうする】**を徹底して入れるようにしました。

×：設定を変更する
◯：【作業者】が【/etc/httpd/conf/httpd.conf】の【80行目】を【443】へ書き換える
これだけで、誰がやっても同じ結果が出る「プロの資料」になります。

複雑な構成図を見て、どこから手を付ければいいか途方に暮れたことはありませんか？私はドキュメントを書く際、図をいきなり書き始めるのをやめました。

図を書く前に、**「今から話すのは、ネットワークの話か？サーバーの中身の話か？」**と、情報のレイヤーを分けました。

ドキュメント作成は、次に作業する人への「思いやり」です。

「ドキュメントの読み解き方がわからない」「技術を言語化するのが苦手」という方へ。
ハンズオンラボでは、実際に手を動かした内容を「自分の言葉でまとめる」練習も大切にしています。

✅ アウトプットすることで、技術の理解がさらに深まります
✅ 現場で役立つ「伝わる資料」の作り方を共有し合えます
✅ 仲間からのフィードバックで、自分の癖に気づけます！