エンジニアの手順書作成

質問

閲覧ありがとうございます。

インフラエンジニア歴2年目の若輩者です。

現在手順書の作成で四苦八苦してます。
本番環境での作業手順なのですが金融系の為かとても細かい操作レベルでの手順を要求されます。
かつ順序や整合性を合わせて作るのがとても難しいです。レビュー等で指摘された手順を追加しようとしたら他のところで整合性が取れなくなったり等がとても多く、レビューしたあとの手順の方が駄目になったりします。また、手順自体が長い(項番が20位)ので余計にミスも多くなります。

どうすれば整合性が取れて、且つ素早く作成できるでしょうか？ベテランの皆様のノウハウをご教示ください。

回答No.1

hue2011

教わっていないのですか。

ソフトを記述する基礎中の基礎に、IPOあるいはHIPOと言われるものがありますね。
当然知ってますね。
IPOは要するに、入り口に入ってくるもの、出口からでていくものを明確にし、中でやることを書くだけです。

当然システム1つに対し1個書けますが、機能がありますからその単位でも当然書けます。

これはプログラマが何と何を意識すればいいのかを整理し、責任外のものにさわらないようにするという効果があります。
また、プログラミングを知らない御客様側と相談するのにもかなり役に立ちます。
単なる図面であり細かい技術内容が入っていませんから。

そうやっていろいろ描いたIPOがどういうからみで全体が作られるかを展開するのがHであって、全体でHIPOというわけです。

この視点で記述していけば、複雑なことは何もないはずです。

プログラムの流れを記述しようとするからいけないのです。
フローチャートの考えが一番よくない。あれは論理をプログラム側に落としてしまう上、たどって読まないと全体が分かりませんから。しかも大型機でほとんどバッチジョブを開発していた文化そのものなので、イベントという考え、割り込みの概念が記述できません。