IT技術 副業

システム方式設計に書くこと:目次の概要

IT技術
おく
おく

システム開発において、システム方式設計が大切といわれていますが、何を書いたらいいのでしょう。
何を書いたらいいかを知らずに役に立つシステム方式設計はできませんね。
今回は、システム方式設計書の目次について紹介します。
今回紹介する目次の下に詳細章があります。
それは後程。

システム方式設計書の目次(概要)

システム方式設計の目次は次の構成をお勧めします。

  • 第1章システム構成
  • 第2章オンライン方式
  • 第3章バッチ方式
  • 第4章帳票方式
  • 第5章データベース方式
  • 第6章ファイルアクセス方式
  • 第7章エラー処理方式
  • 第8章ログ出力方式
  • 第9章文字コード方式
  • 第10章セキュリティ方式
  • 第11章業務共通方式
  • 第12章他システム連携方式

では、各章の概要を説明していきます。

第1章システム構成

主には構築するシステムが動作する環境の話を書いていきます。
構築するシステムの外観イメージを書きます。
例えば、次のような要素になります。
・WebサーバとDBサーバと帳票サーバがつながっている
・連携する外部システム
・開発するシステムではどのようなミドルウェアやアプリケーションを利用するのか
・負荷分散するのか、するならどのような方式か

第2章オンライン方式

Webシステムを構築す場合はこの章が主要部分になります。

記載事項は非常に多くなります。
・アプリケーションの構造(機能・部品の構成やクラス構成パターン)
・セッション制御
・トランザクション制御
・アクセス権限
・業務規制
・検索制御
・画面遷移
・入力チェック
・メッセージ表示
 ・・・
などなど、記載する事項は非常に多いです。

第3章バッチ方式

バッチに関する仕組みを設計する章です。
オンラインと同様に設計項目が多い章ですが、オンラインよりも仕組みが単純なため設計項目は少なくなります。
・アプリケーション構造
・バッチの起動方法
・状態監視
・中断方法
・メッセージ通知
・トランザクション制御
・多重処理
・ファイル処理

第4章帳票方式

帳票出力が必要な場合に仕組みを考えます。
プリンタで印刷物を出力する場合、PDFなどの電子データを出力する場合、どちらも帳票方式です。
・アプリケーション構造
・出力方法
・管理方法(履歴)

第5章データベース方式

オンライン方式、バッチ方式に含めても構いませんが、設計内容が多いこととオンライン・バッチの共通設計となるため一つの章として独立させます。
主には採用するDB(ORACLE、SQLServerなど)の特性も考慮しながらDBの使い方を設計します。
・アクセス制御
・トランザクション制御
・排他制御
・デッドロック制御
・削除方式
・履歴管理
などです。

第6章ファイルアクセス方式

ファイルに対して入出力がある場合に設計する項目です。
・ファイル形式
・アクセス方式(読み込み、書き込みのルール)
・チェック処理
などです。

第7章エラー処理方式

エラーが起きた場合の動作について設計します。
ここでいうエラーは例外エラー(Exception)のようなシステム操作が継続が不可能になるようなエラーです。
入力を誤ったらメッセージが出るようなエラーはオンライン方式、バッチ方式に含みます。
発生したエラーを検知してログに記録したり、システム管理者に通知する方法を設計します。

第8章ログ出力方式

システムの動作を記録する仕組みです。
そのような内容を記録するのか。
例えば、エラーが起きたときの情報だけ記録するのか、システム利用者の操作を記録するのかなど何を記録するのかを決めます。
他には、ログを記録する仕組みはどうするのか。

第9章文字コード方式

扱う文字について制約事項を決めます。
・文字コード
・利用不可な文字(外字など)
・文字コード変換方式(他システム連携がある場合など)
・フォント

第10章セキュリティ方式

セキュリティにかかわる事項をすべて記載します。
・ユーザー認証
・ブラウザなどの設定条件
・セッション管理
・cookiの取り扱い
・インジェクション対策
・エコーバック対策
・クロスサイトリクエストフォージェリ
・サニタイズ
・暗号化
など

第11章業務共通方式

業務固有の仕組みを設計する章です。
内容は多岐にわたります。
少々まとまりのない要素が集まった章になっています。
「その他方式」としてもいいかもしれません。
・採番方式
・業務日付
・複数言語対応
・業務権限
など

第12章他システム連携方式

他システムと連携がある場合の仕組みを設計します。
どのようなデータ形式でやり取りするのか、連携するタイミング、連携でエラーが起きたらどうするのかなどを設計します。

まとめ

今回はシステム方式設計の構成概要を紹介しました。
ご覧の様に、システム方式設計の設計項目は多岐にわたり、ボリュームも非常に大きいです。
それがゆえに、一つずつの設計が雑になりがちです。
しかし、丁寧に設計していくことで役に立つシステム方式設計が出来上がります。

コメント

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