2020/05/24

内部仕様書のテンプレート

背景


仕事の中でシステムやソフトウェアの開発を行う際、内部仕様書を書く機会が増えてきたので、外部仕様書に必要な項目をまとめた。


記事の目的


内部仕様書を効率的に作成するため、内部仕様書のテンプレートを作成する


内部仕様書とは


内部仕様書は、詳細設計とも呼ばれている。外部仕様書の目的は、複数名で開発を行う場合、外部設計の結果を受けて効率的に実装作業を行えるように実装内容を整理することである。


内部仕様書の全体構成



外部仕様書の船体構成は、下記の通りである。
  • クラス図
  • システムを構成するクラスとクラス間の関係を表す。
  • 内部データ
  • システム内部で使用するデータ一覧(データ名、データ型、データ長、その他制約)について記載する。
  • 機能
  • 下記の項目を機能毎に作成する。
    1. 機能名
    2. 機能名を記載する。
    3. 入出力値
    4. 入出力値のデータ名、データ型、データ長、その他制約について記載する。
    5. 他の機能モジュールとの関係性
    6. 他の機能モジュールとの関連性(データの流れ、データ名)について記載する。
    7. アクティビティ図
    8. 処理内容をアクティビティ図で記載する。
    9. シーケンス図
    10. 処理詳細をシーケンス図で記載する。


まとめ


  • 内部仕様書のテンプレートに関して記述した


参考文献




変更履歴


  1. 2020/05/24: 新規作成



0 件のコメント:

コメントを投稿

MQTTの導入

背景 IoTデバイスの接続環境構築のため、MQTT(mosquitto)の導入を行った。 記事の目的 MQTT(mosquitto)をUbuntuに導入する mosquitto ここではmosquittoについて記載する。 MQTT MQTT(Message Qu...