初心者向け講座早見表
「ドキュメントを整備しましょう。」システム開発をしている現場であれば、当然、聞いたことがあるお話だと思います。また、システム開発の現場にいる人は、多かれ少なかれ、ドキュメントの重要性は感じているのではないでしょうか。
中には全くドキュメントは必要ないと言われる方もいるかもしれませんが、そのような方であっても、メールやソースコードのコメントなど、何らかの方法でドキュメントを残している事と思います。
ドキュメント整備の重要性は、既に皆さんが実感しているかもしれませんが、改めて「システム開発時」と「システム運用時」の2つの視点からドキュメント整備の重要性を考えてみたいと思います。
◆システム開発
・品質向上
ユーザー部門などのシステム利用者との認識合わせ、設計者・開発者・テスト実施者など、異なる役割のメンバー間での認識合わせのツールとすることで、誤認識の排除に繋がります。
・手戻りの削減
早い段階で先を見通したドキュメントを整備しておくことで、開発前のシミュレーションとなり、要件・設計漏れの防止に繋がります。
・仕様変更対応
仕様変更やスケジュール遅延などにより、急激な要員追加が発生しても、あらかじめドキュメントが整備されていれば、早い実務参加が期待できます。
◆システム運用
・安定的な要員の確保
システム運用チームへの新規参画者がシステムを理解するための足掛かりになります。
・コスト削減
システム改修などのメンテナンス実施の際に、短期間で影響分析やテストケースを洗い出すための重要な資料となります。
・品質向上
システム改修などのメンテナンス実施の際に、影響分析漏れやテストケース作成漏れを防ぐための重要な資料となります。
システム開発をしている立場と、システム運用をしている立場とでは、ドキュメントに対するとらえ方が大きく異なるのが見えてくると思います。システム開発をしている時は、システムが動くまでを考えれば良いのですが、システム運用の立場から見ると、初めて触れるシステムであったり、見たことがないモジュールを想像しながら運用しなければなりません。その為、ドキュメントがとても重要な位置づけとなります。
このように、ドキュメント整備の重要性はいろいろと挙げられますが、実際にドキュメントを作成するとなると、いろいろな難問が待ち構えています。
・何のドキュメントを作れば良いのかわからない。
・せっかくドキュメントを書いても、読んでもらえるのか、意味があるのか疑問。
・そもそも、ドキュメントを作っている時間が無い。
そこで、次回以降のコラムでは、ドキュメントを整備する際のポイントについてお話ししていきたいと思います。
本コラムが、読者の皆さんの日々の業務に役立てば幸いです。
（担当：小口 真己）
