IT技術 副業

役に立つシステム方式設計書にするポイントは3つ

IT技術
おく
おく

システム方式設計書にはどんなことを書けばいいのでしょうか。
そこそこ手間と時間をかけて作る割には、まったく使われないなんてことはないですか?
作らなきゃいけないから、とりあえず作るなんてことになってないですか?
せっかく作るのですから有益なものにしたいですよね。
有益なシステム方式設計書にするために抑えるポイントを3つお教えしましょう。

結論

システム方式設計をする目的は次の3つです。
・クライアントとの仕様のすり合わせ
・仕様の説明
・実現方法の具体化

この目的を達成するように書けばいいのです。
各カテゴリに対して
・概要(要件の説明)
・方式詳細(仕様の説明)
・実装方法(実現方法の具体的説明)

システム方式設計の目的

システム方式設計の目的は次の3つです。
・クライアントとの仕様のすり合わせ
・仕様の説明
・実現方法の具体化

詳細は以下をご覧ください。

クライアントとの仕様のすり合わせ

システム方式設計に記載する項目ごとにクライアントの要件を整理して、認識違いがないか確認します。

仕様の説明

どのような仕組みにするのか設計します。
システム方式設計書の中心になる部分です。

実現方法の具体化

この仕組みをどのように利用してシステム構築するのか、開発者に向けた使い方の説明をします。

システム方式設計書に記載する3つのこと

手間と時間をかけて作成するシステム方式設計書を役に立つものにするには、3つのポイントを押さえて作成することです。
それは、システム方式設計書の目的を満たすことです。

その目的を満たすために、各カテゴリの章立てを工夫します。
次のような章だてがよいでしょう。
1.概要
2.方式設計
3.実装方法

例えば次のようなイメージです。

このように、設計書の構成をパターン化することで必要なことを漏らさず設計できるようになります。

では、3つのことには何を書いたらいいのでしょうか。

3つのことに何を書くか

各章にそれぞれ記載する3つのことには何を書くのか。
3つのことはそれぞれシステム方式設計の目的に該当します。
目的に沿って書けばよいです。

1.概要

目的の「クライアントとの仕様のすり合わせ」にあたります。

クライアントからのシステムに対する要件を記載します。
要件に加えて、それを実現する手段を簡単に記載します。

〇〇(要件)を実現するために、△△(方式)の方法を採用する。

のような書き方を基本とするとよいでしょう。
例えば、クライアントサーバ方式ではなくWebアプリケーション方式を採用する場合は「不特定多数の利用者が利用可能とするために、Webアプリケーション方式を採用する」とい感じでしょうか。

「△△(方式)」ありきで「〇〇(要件)」が考えられていない場合もあります。
その時はなぜその方式を採用するのか理由を考えてみましょう。
その理由によっては誤った方式採用をしているかもしれません。

副業ポイント

副業でシステム構築を受注する場合は、特にここは重要です。
クライアントの要件を整理して、おかしなところがあれば指摘をしておかないと、のちに仕様変更などのトラブルになる可能性があります。

2.方式設計

目的の「仕様の説明」にあたります。

採用する方式の仕組みをなるべくわかりやすく説明します。
図を使いながらわかりやすい説明にすることを心がけましょう。
設計書の心臓となる部分です。

ここで気を付けたいことは「説明する相手は誰か?」という事です。
基本的には開発者向けの説明となりますが、一部クライアントにも説明と仕様の合意が必要な場合もあります。

3.実装方式

目的の「実装方法」に当たります。

方式設計の内容を構築するシステムの中でどうやって実装するのかを説明します。
この仕組みを利用するためのインターフェイス(API)の説明やソースコード、SQLなどの書き方を説明します。
簡単に書こうとするなら、この方式を利用したサンプルソースなど記載します。

説明する相手は開発者のため、ソースコードやSQLのサンプルでもよいでしょう。

実装方式については、すべての章で必要なわけではありません。
環境説明をしている章やミドルウェアによって実現される方式の場合は必要ない項目です。

コメント

タイトルとURLをコピーしました