忘れちゃいけない「マニュアル」作り

忘れちゃいけない「マニュアル」作り

「テストが終わって一応システムは完成したとしましょう。あなたはそのまま納品するつもりなの？」

「だって、必要な要求を満たしたソフトウェアを、きちんと動作するかテストした上で納品するんですよ〜」

「それを納品された人は、どうやってそのシステムを使うの？」

「使い方は別料金で！」

「…ギャグ、よね？」

「は、はいぃ（がくがくぶるぶる）」

「わかっているならいいわよ。ほんとにわかっているならね。実際には、納品物にはシステムを使うためのマニュアルがなければだめ。そのマニュアルも開発ドキュメントの1つよ」

「はい！」

「まぁ、実際の現場によってはマニュアルの部分は開発ドキュメントに含まないというケースもあるけれど、やはりトータルで考えた場合にはマニュアルも開発ドキュメントの1つとしたほうがいいわね」

「それはなぜですか？」

「もちろんマニュアルはマニュアルとして執筆する部隊が別にいてもいいわ。でも開発に関わっていない人がマニュアルを作るためには、マニュアルを作るために必要な開発ドキュメントをそろえなくてはいけないわね」

「あ、確かに！」

「それに、開発に携わっている人以外がマニュアルを作ると、最終的に実装しなかった機能があったりしてもそれに気づかずにマニュアルに盛り込んでしまったり、ということも発生するわ」

「それは大変ですね」

「だから、マニュアルについても開発に携わった人が書く、つまり開発ドキュメントの1つに含めるべきだと思うわ」

「わかりました〜」

図3：開発ドキュメントの妖精の戦いは続く！

開発ドキュメントの妖精の戦いは続く！

「さ、これで1つのプロジェクトで必要な開発ドキュメントについては一通り流れを理解できたかしら」

「はい！　これで私たちの仕事も…」

「（※ためいき※）」

「終わり、じゃないんですか？」

「これから実際にシステムが納入されて、実際に稼動しつづけている限り、開発ドキュメントはとても重要な資料として使い続けられるわ。そのときに備えて、細かなバグ取りや修正の内容はドキュメントに反映しておかなければね」

「はい、わかりました！」

「さ、それがわかったら次の開発現場に行くわよ！　今度はA奈1人でどこまでやれるかみさせてもらいますからね！」

「はい〜！」

ナレーション「1つのシステム開発が終わった。しかしA奈ちゃんやB乃ちゃんの仕事が終わったわけではない。きっと彼女たちがあなたの開発 現場に来る日もあるだろう（基本的に、彼女たちが来る＝デスマーチ一直線、なのでありがたくはないのだが）。A奈ちゃんとB乃ちゃんに再開するそのときま で『開発☆ドキュン』でどっきゅドキュ！（完）」