これらがない案件はストレスが多いのでやめた方が良い。数年やってて用意されてないのは怠慢or 無知でしかなく、悪い文化が根付いており、変わる可能性は低い。
- シーケンス図 ★★★
- 画面仕様書 ★★
- API仕様書 ★★
- DB定義書 ★
どれか1つでも欠けているプロジェクトはエンジニアリングレベルが低いと考えて良い。
どれかが欠けている状態で良い仕事をするのは不可能。
顧客要望にスピーディーに対応することはできないし、精度の高い回答をすることもできない。
だから、これらのドキュメントだけは死守した方が良い。
シーケンス図は、アプリ、バックエンドAPI、バックエンドからの他システムやDBの呼び出し順序と呼び出し対象が分かれば良い。細かいロジックが書いてある必要はない。
画面仕様書は、画面の各項目はAPIのどの項目を表示しているかが書かれていること。
API仕様書は、リクエスト／レスポンスの項目と、レスポンスの各項目の取得元や編集仕様が書かれていること。他システムと連携する時はその情報も必要。
DB定義書はDDLから自動生成したもので良い。
これらのドキュメントがない場合、プロジェクトの初期メンバーが抜けたらそのプロジェクトは終わる。残るメンバーへのシワ寄せが起き、良い提案をスピーディーに顧客にすることができなくなり、質の低い精度の悪い提案が常態化する。
その結果、あっという間に顧客の信頼は失われ、プロジェクトは解散に追い込まれる。