こんにちは。大藏(大蔵)陽平と申します。
システム開発の現場で10年働いてきて、プロジェクトがうまくいかない
原因の多くは、技術的な問題よりも「認識のズレ」から生まれていると
感じています。
特に要件定義のフェーズは、ここで丁寧にやっておくかどうかで
その後の全工程が変わります。今日はドキュメント作成のときに
僕が意識している、シンプルなコツをいくつかシェアします。
まず大切にしているのは、主語を省さないことです。
「承認後に通知する」という記述は、一見わかりやすく見えますが
誰が承認して、誰に通知するのかが曖昧です。
こういった文章が積み重なると、実装段階で「そういう意味じゃなかった」
というズレが生まれます。
面倒でも「管理者が承認した後、申請者にメール通知する」
と書き切る習慣が、後々の手戻りを大幅に減らします。
次に意識しているのは、例外ケースを先に書くことです。
正常系の流れだけを書いたドキュメントは、読んでいる分にはわかりやすい。でも実際の開発では、例外処理の仕様が曖昧なまま進んでしまうことが多い。「エラーが起きたときどうするか」「入力が空のときどうするか」を
仕様書の段階で明記しておくと、認識のズレが格段に減ります。
最後は、確認のタイミングを細かく設けることです。
完成したドキュメントを一度にレビューしてもらうより、
セクションごとに小まめに確認を取る方が、ズレを早期に発見できます。
認識を揃えることは、誠実な仕事の基本だと思っています。
ご相談はお気軽にどうぞ。
