脱・属人化！誰でもできるネットワーク機器設定手順書の作成ガイド
1.ネットワーク機器設定手順書とは
ネットワーク機器設定手順書(作業手順書、設定変更手順書等)は呼称は現場によってそれぞれだが、
項目は似た内容で記載されている。下記の資料はサンプルでフォーマットや表現はまちまちだが、
ネットワーク機器設定手順書(作業手順書、設定変更手順書等)となる。
サンプルを参考に各項目について説明する。
・シートの1行目に作業名の記載欄を作成
作業名は分かり次第記載する。
・シートの2行目に作業日記載欄を作成
作業日は分かり次第記載する。
・A列に項番記載欄を作成
・B列に大項目記載欄を作成
大項目は作業内容がカテゴリー分けするように気を付けて記載する。
)例 作業前準備、設定変更、作業確認、作業後確認等
・C列に中項目載欄を作成
中項目は具体的な作業内容を記載する。
)例 ログイン確認、作業前ログ取得、インターフェース設定変更、作業後ログ取得、
config差分比較等
・D列にチェックリスト欄を作成(現場によってはない)
チェックリストが無い代わりに作業完了時間欄を作成し、作業完了後に時間を入れるとグレーアウト
するようにしていた。
・E～F列に作業内容及びコマンドを作成
コマンドを記載する際はコピー&ペーストして投入できるように不要な半角全角スペースが無いか
気を付ける。
現場によっては別シートに投入コマンド、configを記載してコピー&ペーストして投入できるように
していた。
・G列に作業予定時間欄を作成
事前におおよその作業開始時間を記載する。
※注 実作業時間と大きく乖離しない程度に記載するよう心掛ける。
・H列に作業時間欄を作成
作業開始出来次第記載する。
※注 ここの項目に記載漏れがあると障害が発生した時に原因調査で発生時間を特定出来ないので、 作業時は必ず記載する。
・I列に作業者欄を作成(現場によっては作業名の隣に作業者、作業確認者欄がある)
作業者が分かり次第記載する。
※注 記載しないと障害が発生した時に誰が作業を行っていたか特定出来ない為、必ず記載する。
・J列に作業確認者欄を作成(現場によっては作業名の隣に作業者、作業確認者欄がある)
作業確認者が分かり次第記載する。
私が経験した全ての現場がExcelで作成され、リモートで作業を行う場合や直接実機に投入する際は
手順書にコマンドを記載してコピー&ペーストして利用していた。
また、現地で物理作業のみ行う場合にも同様に作業手順書を作成していた。
基本的に過去に作業実績がある現場では手順書のひな形のフォーマットがあるので、ゼロから作成ではなくひな形を元に実際作業する内容に合せて修正していく方式を取ることが多い。稀に手順書は無いが投入コマンド、configのみメモ帳に記載して作業する現場もあった。
手順書がない代わりに作業前ログ、作業中ログ、作業後ログに分けて細かくログ取得をしていた。
2.ネットワーク機器設定手順書作成ポイント
ネットワーク機器設定手順書作成ポイントをいくつか挙げていく。
・まず、手順書作成の前にひな形または過去使用していた手順書がないか確認する上記でも触れたが、
一部を除いてほとんどの現場がひな形か過去使用していた手順書があるので確認してから作成すると
あまり時間をかけずに作成できる。ゼロから手順書を作成する現場は滅多にないので、
案件に参画した際はひな形か過去使用していた手順書を探す。
・誰が見ても理解できる内容を意識して記載する
たまに作業内容をあまり記載せずにコマンドやconfigのみ記載している手順書がある。
この場合、作成者のみしか理解できない内容の可能性が高いので、第三者が作業した際に誤った作業を
してしまうリスクがある。また、誰が見ても理解できる内容については新卒の作業者が見ても理解できる
程度のレベルに合わせた内容が望ましい。設定変更作業は基本的に経験が浅いエンジニアが担当する
ケースが多いので、そういう意図もあって述べた。現場の方針によって様々ではあるが、私の経験では経験のある無しだけでは無く手順書の作成者が作業をしないケースも多かった。
・コマンド、configは手打ちしなくても良いようにコピー&ペーストできるように手順書に記載する
今はあまり見かけることは減ったが、少し前の現場ではコマンド、configを手打ちしている現場が過去にあった。そういった現場では、ある程度件数をこなすと必ず手打ちミスが発生していた。障害内容によっては、他の機器にも影響してしまう程の障害が発生した現場もあった。そういった事態を未然に防ぐために、現在の現場ではほぼコマンド、configは手打ちではなくコピー&ペーストできるように手順書に記載している。
・作成後は誤字脱字が無いかチェックする
手順書に限ったことでは無いが、手順書作成後はある程度時間をかけてセルフチェックを行う。
そうすることにより、誤字脱字や内容に誤りを発見できる。また、同じ設定内容やコマンドを記載した際は目視とExcelの検索機能を使い同様の内容が記載されているか確認する。
参考文献
https://mizusibuki.com/net-checksheettemp
