基本的に、私はプロジェクトや仕事の依頼に関する技術仕様と機能仕様の両方を書くための優れたテンプレートを探しています。
あなたは何を使うのですか?仕様を書いている間、あなたはどのくらい深くなりますか? あなたが提供できる追加の一般的なヒントをいただければ幸いです。
私の会社はこれらをひどく必要としています。私は請負業者で働いていますが、現在、これらの文書はまったく使用していません。
編集:私は痛みのない仕様に関する Joel の見解を読みました。本当に気に入りましたが、他の意見はありますか :)
基本的に、私はプロジェクトや仕事の依頼に関する技術仕様と機能仕様の両方を書くための優れたテンプレートを探しています。
あなたは何を使うのですか?仕様を書いている間、あなたはどのくらい深くなりますか? あなたが提供できる追加の一般的なヒントをいただければ幸いです。
私の会社はこれらをひどく必要としています。私は請負業者で働いていますが、現在、これらの文書はまったく使用していません。
編集:私は痛みのない仕様に関する Joel の見解を読みました。本当に気に入りましたが、他の意見はありますか :)
一般的なヒントについて。
のプロセスを実施しています。
1) ビジネス要件ステートメント (BRS)
2) 機能仕様
3) 技術仕様
BRS は、ビジネス上の問題と、ソリューション、テスト、セキュリティ、信頼性、および配信に関する要件をカバーしています。これにより、成功するソリューションとは何かが定義されます。
機能仕様には、必要なもの、外観、フィールドの長さなどの詳細が記載されています。
技術仕様には、データの取得元、考慮が必要なトリッキーなコードの詳細が記載されています。
顧客は要件を所有しています。開発者は技術仕様を所有しており、機能仕様はその中間です。テストは、技術仕様 (通常は単体テスト) に対して、次に機能仕様 (通常はシステム テスト)、そして要件 (UAT) に対して行われます。
これの重要な部分 (そして私たちが苦労しています) は、開発者がまだ機能仕様と元のビジネス要件を提供する必要があるということです。実際には、機能仕様と技術仕様はわかりやすくするためにあります。
要するに、私の主なヒントは、最初に実装したいプロセスを解決することです。次に、提案されたプロセスに関係するすべての関係者の同意を求めてから、テンプレートに合うように作業します。テンプレート自体は、変更したい変更のほんの一部です。
テンプレートではありませんが、Joel は機能仕様の作成に関する記事をいくつか書いています。彼はここにもサンプルを持っています。
テンプレートは ieee などから購入できますが、私はいつも自分で作成することになります。
技術仕様については、Steve McDonnell による「Code Complete」に優れたチェックリストがあり、そこから情報を引き出すことができます。私の最後の仕事では、彼のセクション ヘッダーからテンプレートを作成し、そこから微調整しました。
機能仕様に関する限り、重要なことはすべてのインターフェースを定義することです。
ビジネス ルールのセクションも必要です。これは、機能的に重要であり、どのインターフェイス定義にも含まれていません。
本を購入したい場合は、Karl Wiegers による Software Requirements に付録としていくつかのドキュメントのテンプレートがあります。残念ながら、私は仕事中で、その特定の本は家にあります。誰かが手元にあれば、それを確認できるかもしれません。
とりわけ、これが好きです: ReadySet。
彼はプロ版も販売しています。
これは私が見つけた最高のものです: http://www.jiludwig.com/templates/FRDTemplate.doc
簡単なことから始めて、そこから始めてください。これは初めての作業なので、箇条書きの Word 文書を使用してください。書いて、読み直して、意味を成すのに十分な詳細を提供してください。技術仕様の場合、開発者をソリューションに導きたいと思うかもしれませんが、機能仕様の場合、「方法」は完全に欠落している必要があります。
ここで、Roberston の Volere テンプレートを参照することをお勧めします。彼らは、Tom DeMarco や Timothy Lister などの "Peopleware" で有名な人々と共に、Atlantic Systems Guild の一員です。
テンプレートは著作権で保護されているため、ここでは複製しませんが、主なヘッダーのいくつかを示します。
他にもたくさんありますが、これでアイデアが得られるはずです。テンプレートの最も興味深い部分は、一種のキュー カードに機能要件をリストする要件シェルです。再び著作権で保護されていますが、本当に価値があります。
ここの第9章を見てください。