読者です 読者をやめる 読者になる 読者になる

ビープラウド社長のブログ

株式会社ビープラウドの社長が、日々の思いなどを綴っていきます。

ドキュメントの必要性認識

開発方法論

「ドキュメントはつくれと言われるからつくるのではなく、必要だからつくるものである」

私はそう思います。

例えばUMLでユースケース図という図があります。

ユースケース図には、ある一つの機能(ユースケース)とシステム利用者、もしくは外部システムなど(アクター)を記述していきます。ユースケース図を作成すると、システム開発プロジェクトを推進する上で有益な以下のような情報が明確になり、プロジェクトの全体像をつかみやすくなります。

・システムにどのような機能(ユースケース)が存在するか
・誰がその機能を使用するのか
・開発対象のシステムスコープ(システム化する範囲)

これらをもとに、規模間の把握、見積もり、ステークホルダーの把握、開発範囲の明確化を行っていきます。

これらの情報を自然言語ではなく、図示することで直感的になるので、情報の漏れ、抜けが出る可能性が減り、プロジェクトのリスクも大幅に下がります。これが、ユースケース図を作成する必要性です。

プロジェクトの情報を図示化、ドキュメント化してかたちにすることの有益性、重要性、必要性を認識できているエンジニア、そしてそれを自ら実践できるエンジニア。そのようなエンジニアはシステム開発プロジェクトにとどまらず、全ての仕事で貴重な存在であり続けるでしょう。