技術仕様および機能仕様のテンプレート [終了]

StackOverflow https://stackoverflow.com/questions/52290

質問

基本的に、私はプロジェクトまたは作業リクエストの技術仕様と機能仕様の両方を記述するための優れたテンプレートを探しています。

あなたは何を使うのですか？仕様書を書くときにどれくらい深く考えますか?その他の一般的なヒントを提供していただければ幸いです。

私の会社はこれらを非常に必要としています。私は請負業者で働いていますが、現在、これらの文書はまったく使用されていません。

編集： ジョエルの見解を読みました 無痛仕様, 、とても気に入りましたが、他に意見はありますか:)

役に立ちましたか？

解決

一般的なヒントについて;

というプロセスを導入しています。

1) ビジネス要件記述書 (BRS)

2) 機能仕様

3) 技術仕様

BRS は、ビジネス上の問題とは何か、またソリューション、テスト、セキュリティ、信頼性、配信に関する要件は何かをカバーします。これにより、何が成功するソリューションとなるのかが決まります。

機能仕様には、何が必要か、どのように見えるべきか、フィールドの長さなどについて詳しく説明されています。

技術仕様には、データの取得元、考慮が必要なトリッキーなコードが詳しく記載されています。

要件は顧客が所有します。技術仕様は開発者が所有しており、機能仕様はその中間です。テストは、技術仕様 (通常は単体テスト) に対して行われ、次に機能仕様 (通常はシステム テスト) に対して行われ、次に要件 (UAT) に対して行われます。

この点で重要な点 (そして私たちが苦労している点) は、開発者が依然として機能仕様と元のビジネス要件を満たさなければならないということです。実際には、機能および技術仕様は明確にするために記載されているだけです。

つまり、私の主なヒントは、まず実装したいプロセスを検討することです。次に、提案したプロセスに関係するすべての関係者に同意を求め、適合するテンプレートに取り組みます。テンプレート自体は、必要な変更のほんの一部にすぎません。

他のヒント

テンプレートではありませんが、ジョエルは いくつかの記事 機能仕様の作成について。彼も持っています サンプルはこちら.

ieee などからテンプレートを購入できますが、私はいつも自分で作成することになります。

技術仕様については、「コードの完成Steve McDonnell の「」には優れたチェックリストがあり、そこからいくつかの情報を引き出すことができます。前回の仕事では、彼のセクション ヘッダーからテンプレートを作成し、そこから微調整するだけでした。

機能仕様に関する限り、重要なことはすべてのインターフェイスを定義することです。

  1. UI（画面モックアップ）
  2. ソフトウェアインターフェース（プラグインなど）
  3. ハードウェア インターフェイス (該当する場合)
  4. 通信インターフェース (サービス、電子メール、メッセージングなど)

ビジネス ルール、つまりインターフェイス定義ではカバーされていない機能的に重要なものに関するセクションも必要です。

本を購入したい場合は、 Karl Wiegers によるソフトウェア要件 付録としていくつかのドキュメントのテンプレートが含まれています。残念ながら、私は仕事中で、その本は家にあります。誰かがそれを手元に持っていれば、それを確認できるかもしれません。

とりわけ、私はこれが気に入っています。 レディセット.

プロ版も販売しています。

これは私が見つけた中で最高のものです: http://www.jiludwig.com/templates/FRDTemplate.doc

簡単なことから始めて、そこから作業を進めてください。これを扱うのは初めてなので、箇条書きが記載された Word 文書を使用してください。書いて読み直し、意味が分かる程度の詳細を提供してください。技術仕様の場合は、開発者を解決策に導く必要があるかもしれませんが、機能仕様の場合は、「方法」が完全に欠けている必要があります。

Roberston の Volere テンプレートをご覧になることをお勧めします。 ここ. 。彼らは、「Peopleware」で有名な Tom DeMarco や Timothy Lister のような人々とともに、Atlantic Systems Guild の一員です。

テンプレートは著作権で保護されているため、ここでは転載しませんが、主要なヘッダーの一部を紹介します。

  1. プロジェクトの目的
  2. 利害関係者
  3. 必須の制約
  4. 命名規則と用語
  5. 関連する事実と仮定
  6. 業務範囲
  7. ビジネスデータモデルとデータディクショナリ
  8. 製品の範囲
  9. 機能要件
  10. ルックアンドフィール要件...

他にもたくさんありますが、これでアイデアが得られるはずです。テンプレートの最も興味深い部分は、一種のキュー カードに機能要件をリストする要件シェルです。こちらも著作権で保護されていますが、本当に価値があります。

見て ここ 第9章で。

ライセンス： CC-BY-SA と 帰属
所属していません StackOverflow
scroll top