はじめに
システム開発の中で作成される設計書ですが、とても重要な存在です。
しかし、実際の現場では設計書の正しい運用ができていないのが現状です。
また設計書の中身に関しても、品質が安定していないこともあります。
設計書の役割をきちんと理解し、設計書の品質向上させる必要があります。
設計書を正しく運用し、システムの平和的な開発・運用を目指しましょう。
設計書を作成する目的
1. システム完成イメージの共有
事前に設計書を作成しておくことで、開発者と発注者の認識のずれ防止ができます。
システムの納品後、トラブルを起こさないよう設計書作成の段階で仕様などは発注者含め確認し認識を合わせましょう。
2. システム開発方針の統一化
設計書が作成されていれば、プログラマーへの指示書となり自ら開発を進めることができます。
リーダーが指示をすることなく開発を進めることができる設計書を作成することが理想です。
3. システムのテストケースの洗い出し
リリース前テストのテストケースを洗い出すことができます。
設計書が完璧に整備されているものであれば、テストケースを全て網羅しテストを実施することができます。
4. システム運用保守担当者への引継ぎ
システム開発者から運用保守担当者に設計書を渡すだけで、引継ぎが完了となります。
運用保守担当者は設計書を参考にすれば問い合わせ対応等が可能となります。
目的を満たせる設計書作成の際に意識したいこと
目的を満たせる設計書作成のために、下記を意識してみましょう。
1. システムで使用する用語は統一する
例としては「処理日」と「実行日」と同じ意味でありますが、混在していると可読性が下がります。
また使用する記号(括弧・演算子..)や数字(全角か半角)なども統一したいです。
システム用語集を作成し、使用する用語を統一するのも一つの案です。
2. システムの大事な仕様に関してはできるだけ分かりやすく記載する
例としては税計算処理で小数点が出た場合、四捨五入するかどうかなど曖昧になりそうな部分は色をつける等で強調しましょう。
また処理が複雑になる部分はフロー図を用いて、データ流れが理解できるようにしましょう。
設計書作成者のみが知っている仕様がある状態はなくしましょう。
3. 更新履歴はどこでどのような改修があったか記載する
機能が追加・廃止・変更がどこであったか確認できると、エラーがあった際に原因を特定しやすくなります。
設計書を読む人に伝わるように意識して作成していきましょう。
設計書作成前にプロジェクトメンバーで方針を相談してから進めることが大事です。
設計書を作成する目的
設計書がシステムにおいて重要であり、システム関係者をつなぐ役割を担っています。
しっかりとした設計書の運用ができていれば、システムの平和的な開発・運用を実施することができます。
今からでも実施できる部分を取り入れ、設計書運用の改善に努めましょう。
SmartBee
作業項目や現場情報の一括管理を可能にするクラウドサービスです。
SmartBeeを導入すれば、管理業務の負担が減るばかりでなく、点検現場の状況をリアルタイムで把握でき、ミスやコスト削減につながります。
