技術仕様と設計文書の違いは何ですか?


38

技術仕様とは何ですか?それらは設計文書と同じですか?そうでない場合、違いといくつかの例は何ですか?


1
前者は設計をミスし、後者は技術をミスします。

回答:


33

ソフトウェア設計文書は、システムまたはコンポーネントのレベルである、と一般的に含むことができます。

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

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

技術仕様は、のような設計のすべてまたは特定部分のいずれかの微細な詳細を、説明します。

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

1
それでは、いつ技術仕様を実際に記述する必要がありますか?開発の前に?開発とともに?または後..?
shashwat

2
@ShashwatTripathiは一般に、開発の前に仕様が記述されるため、他の誰か(または後であなた)がコンポーネントを実装できます。開発が完了した後で仕様を記述すると、仕様が無意味になります(実装された内容に関する技術文書として使用しない限り)。
ミラキュリックス

私は、複数年にわたるプロジェクトで巨大企業で働いているこの正確なシナリオに出くわしました。プロジェクトをTestに移行してからProdに移行した後、ビジネス要件ドキュメントを作成するために後方に取り組みました。ええ、素晴らしいプロジェクト管理です。
ThinkCode

詳細が機能的にソフトウェア要件仕様を分解した後、技術仕様は作成されませんか?アーキテクトはSRSなしでTSをどのように作成しますか?彼/彼女はトンを引き受ける必要があるように見えます。
オラキュラーマン

同意します。TSはSRS(システム要件仕様)に従う必要があります。ただし、これらの用語は標準化されておらず、TSはSRSの詳細な形式(組み込みシステムで一般的)として作成されるか、高レベルのSRS、つまり設計文書(商用アプリケーションで一般的)を補完するために使用できます)。重要な点は、要件、設計、および仕様の文書がそれぞれ、システムとそのコンポーネントに関する特定の 1つのビューを記述していることです。正式な定義を満たすよりも、チームが必要なビューと詳細レベルに同意することが重要です。
miraculixx

7

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

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


ありがとうございました。また、基本的には、何をすべきかを知るために機能仕様が必要であり、その後、どのようにすればよいかを知るためにドキュメントを設計する必要があります、それは正しいですか?ちょっとした質問、あなたが言及した機能設計は何ですか(機能仕様の私の理解に混乱を加えないことを願っています)
ジョンV

機能設計では、実装の詳細に入らずに、ユーザーの観点から製品の意図された機能を定義します。ここには、機能的なデザインが何であり、何ではないかについて徹底的な説明を提供する、優れた回答を含む多くの質問があります。
tdammers

1
それでは、いつ技術仕様を実際に記述する必要がありますか?開発の前に?開発とともに?または後..?
shashwat 14
弊社のサイトを使用することにより、あなたは弊社のクッキーポリシーおよびプライバシーポリシーを読み、理解したものとみなされます。
Licensed under cc by-sa 3.0 with attribution required.