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

si プロジェクトでは、顧客にプロジェクトがうまく作られたことを証明するために、ドキュメントを提出する必要があります。

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

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

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

皮肉なことに、順番が間違っていますが、韓国の si 文化では自然に進化した方法です。

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

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

最も扱いやすい新入社員がドキュメント作成を担当することになります。そもそも開発はすぐにできないので、ドキュメント作成をさせるわけです。

そもそも自分がやっておけば、次に後任に任せることができるので、機会があれば一生懸命やってみましょう。