web-dev-qa-db-ja.com

技術仕様と設計ドキュメントの違いは何ですか?

技術仕様とは何ですか?それらは設計ドキュメントと同じですか。そうでない場合、違いは何ですか?いくつかの例は何ですか?

39
John V

ソフトウェア設計文書は、システムまたはコンポーネントのレベルにすることができ、通常は次のものが含まれます。

  • 関連する目標または要件(機能的および非機能的)
  • 静的構造(コンポーネント、インターフェース、依存関係など)
  • 動的動作(コンポーネントの相互作用)
  • データモデルまたは外部インターフェイス(ドキュメントで説明されているシステム/コンポーネントの外部)。そして
  • デプロイメントに関する考慮事項(ランタイム要件、サードパーティコンポーネントなど)。

これらの説明はすべて抽象レベルであることに注意してください。目的は、システムまたはコンポーネントの一般的な理解を読者に提供することです。設計ドキュメントには多くのレベル(システムレベルまたはコンポーネントレベルなど)がある場合があります。

技術仕様は、以下のような、設計のすべてまたは特定の部分の詳細を示します。

  • 必要なすべてのデータ型/構造(入力データ型、出力データ型、例外)を含むインターフェースのシグネチャ。
  • すべてのメソッド、属性、依存関係、および関連付けを含む詳細なクラスモデル。
  • コンポーネントが使用する特定のアルゴリズムとそれらがどのように機能するか。そして
  • 各エンティティ/データタイプの属性とタイプを含む物理データモデル。
34
miraculixx

少なくとも技術設計の形の技術仕様は、たとえば、要件リスト、機能設計、設計文書のpartです。ユーザーストーリー、グラフィックデザインモックアップ、ユーザビリティスタディ、UML図、ビジネスプロセス図、データモデル仕様など.

完成品を文書化するために事後に記述したタイプの技術仕様は、通常は設計文書の一部ではありませんが含まれている場合があります後のバージョン(参照用)またはそれらに依存する別の製品の設計ドキュメントのセット。

7
tdammers