[SI開発者物語] 10. SIプロジェクトにおけるドキュメント化とは？

SI開発者の話
#10. SIプロジェクトにおけるドキュメント化とは？

SIプロジェクトでは、顧客にプロジェクトをうまく作成したという証拠として、ドキュメントを提出する必要があります。

提案書から始まり、画面定義書、設計書、ユーザーマニュアルなど、プロジェクトの段階に応じて、プロジェクトの提案から設計、開発、テスト、オープン後の運用まで、作成する必要があるドキュメントが存在し、通常は新卒開発者が担当することになります。

ドキュメントを作成していると、自分がなぜ開発者になったのか、事務職なのかと錯覚してしまうことがあります。また、韓国では、各段階で実行する必要があるドキュメント化を、プロジェクトの終了直前にまとめて行うケースが多く、その理由は次のとおりです。

• プロジェクト期間が短いため、できるだけ早く作成し、ドキュメントはそれらしく作成して、期間内にプロジェクトを実行するため
• どうせ段階的に作成しても、要件は追加され、変更されるため、作成して修正するよりも、すべて作成しておいて、それに合わせて作成する方が速い。

皮肉にも順番が間違っていますが、韓国のSI文化において自然に進化した（？）方法です。

画面定義書を描くツールはたくさんありますが、完成した運用画面をキャプチャして画面定義書を作成するという奇跡のような場面を見ることができます。

通常、開発者はドキュメント作成といえば嫌悪感を抱きますが、どうすることもできません。あなたは新卒なのですから。

一番手頃な新入社員がドキュメント化を担当することになります。どうせ開発はすぐに任せられないので、ドキュメント作成をさせるということです。

どうせ私がやっても、次に後任にもやらせることができるので、機会があれば一生懸命作成してみましょう。