はてなブックマーク

はじめに みなさんは設計書を書く際に気を付けていることはありますか？ 今回は私が最近設計書レビューをしてて感じる事について記載していこうと思います。 その設計書ただのメモ書きになってませんか？ 何故この記事を書こうと思ったのかですが、 「その設計書はあなたがコーディングをするためだけのものじゃない」 ということをお伝えしたいためになります。 では、具体的に何を意識するのか。 コーダーが何をどのように実装したいのか理解しやすい内容とする。 設計を担当したものを自分が作るとは限りません。 保守・運用を行う際にどのような造りになっているのか分かりやすい内容とする。 開発を行ったシステムを同じ人がそのまま保守・運用を行っていくとは限りません。 要するに、他人が見るドキュメントだということを意識してほしいということになります。