クラウド時代のサーバー運用入門　＞　第12回　作業手順書の書き方とその重要性(応用編) よい作業手順書を書き上げるために 5つのTIPS

私がCTC教育サービスで編集支援している濱田康貴氏のクラウド時代のサーバー運用入門　＞　第12回「作業手順書の書き方とその重要性(応用編) よい作業手順書を書き上げるために 5つのTIPS」が公開されました。

興味がある方はご覧ください。

＃＃＃

さて、前回は「作業手順書の書き方とその重要性 (基礎編)」という内容で、作業手順書の書き方とその重要性について取り上げました。今回は応用編として、よい作業手順書を作成する具体的な手法について取り上げてみたいと思います。

よい作業手順書とは

そもそも論として、よい作業手順書の条件とは何でしょう。
1.作業開始条件と終了条件が明記されていること
2.作業者の前提知識が明確であること
3.文章が崩壊していないこと
4.作業の順序を意識した章立てになっていること
5.紙に印刷したときのことも考慮していること

逆に、作業手順書に「書かなくてよい」ことは次の3つです。
1.プロダクトそのものの解説
2.応用例
3.その他作業手順に関係のない内容

これらの内容に全く触れてはいけない、というわけではありませんが、章立てを意識せずにこれらを盛り込んでしまうと、読み飛ばしや判断の迷いによる作業ミスを誘発する可能性が生じます。もし、そのプロダクトへの深い理解を持ってほしいということであれば、付録に書くか、または別ドキュメントへ誘導するのがよいでしょう。
そして、作業手順書に「書いてはいけない」ことはたった1つです。

この続きは以下をご覧ください
https://www.school.ctc-g.co.jp/columns/hamada/hamada12.html