3

私は (私が働き始めたばかりの場所で) 既存の登録システムに追加されるいくつかの新しい機能の簡単な仕様を作成するように依頼されました。今までやったことがないので、少し助けが必要です。現在のワークフローと新しいワークフローを示す 2 つの図を次に示します。

少し漠然としているかもしれませんが、基本的に何が起こっているのかを以下に示します。既存の Windows アプリケーションに新しいインポート フォームを追加しています。検索を検索し、ocr によって読み取られたデータを入力する検索ボタンを追加して、既存のフォームを変更しています。

私は新しい開発者で、一般的にドキュメントを書くのはかなり苦手ですが、これを改善したいと思っています。たぶん、このようなものを書く方法に関するいくつかの例が役立つでしょう. 私はいくつかの例をグーグルで検索しましたが、私が見つけたもののほとんどは、まったく新しいシステムの作成に関するものです。既存のシステムを変更するための書き方を示すものが必要です。

これが私の仕様の試みです。多分誰かがそれを批判することができます。少なくとも、私は何を改善する必要があるかを知るでしょう。http://cid-ddb3f6a92ec2b97e.skydrive.live.com/self.aspx/.Public/Specs.docx

ありがとう

4

4 に答える 4

3

どんなドキュメントでも: まず、なぜそれを書いているのかを考えてみましょう - 誰がそれを読むのか、彼らは何を知る必要があるのか​​? どの程度の詳細が適切ですか？一般的なアイデアの別のカップル

あなたが書いているものに入る情報源について考えるのに役立つかもしれません. その結果の 1 つは、書いた内容が検証できることを確認することです。たとえば、情報源が人である場合、特に IT 文書の場合、IT 以外の人が何かを話している場合、「情報源」が自分が何であるかを理解できるように、情報をどのように提示するかについて非常に注意する必要があります。と言っています。

また、現在のドキュメントの後に続くものも慎重に検討してください。たとえば、テスト計画はあなたが書いたものに基づいて書かれているでしょうか? これにより、非常に自然にテスト ケースに展開されるテーブルに情報を表示するようになる可能性があります。

だからあなたの特定の質問に。「スペック」って何？あなたが提供するワークフローは、ユーザーが見て「はい、それが私が欲しいものです」と同意するのに十分ではありません。誰かがコードを書くだけでは十分ではありません。複数の書類が必要になると思います。

1)。ある種の要件ドキュメント。使用できる形式の 1 つは、ストーリーボードです。これは、ユーザーが何を見て何をできるかに焦点を当てています。各画面に表示される正確なデータ。表示されるものの根底にある計算がある場合は、これらを説明する付録が必要になる場合があります。このドキュメントは、ユーザーと開発者の両方が読んでいます。パワーポイントやワードが使えます。

2)。そこから、いくつかの明示的なデータ モデルを導き出すことができます。項目ごと、フィールドごと。データ型、サイズ、検証など。日付モデリング ツール、UML、または単なるスプレッドシートを使用する場合があります。主な対象者は開発者ですが、理想的にはユーザー (またはビジネスの仲介者) が詳細を確認できます。[ビジネス アナリストがいない場合は、おそらくあなたがビジネス アナリストです :-) ]

3)。より技術的な、項目 1 と 2 を参照する開発者向けの仕様。実装の分解。モジュール、パッケージ、クラス、または使用しているものの名​​前。変換、アルゴリズム、および計算の定義。より技術的なドキュメント。私は UML を使用しますが、正確な形式のキャプチャで十分です。ここで、ワークフローの詳細なボックスの意味を実際に掘り下げます。

これまで見てきたように、一般に、開発者がセキュリティやデータ ボリュームなどの機能以外の要件を理解していることを確認する必要もあります。あなたの状況では、これは暗黙のうちに理解されている可能性があるため、おそらく今は必要ないかもしれません...他の人生では、将来のために思い出させるために少なくとも1つのライナーを配置することをお勧めします. .

于 2009-08-08T08:44:52.603 に答える
1

これらは、仕様の優れたスタートです。

Windowsアプリケーションをどのように見せたいかのモックスクリーンショットを作成することで、それらに追加します.

その上に、各データ フィールドの詳細と、許可される値を追加できます。

考えられる例外の詳細と、エラーの報告方法を含めます。

また、設計に含める必要があるため、必要なレポートとセキュリティ/監査の種類を検討することもできます。

最後に、開発者と一緒に座ってプロセスを説明し、各ステップを進めていく価値があります。詳細が必要になると確信しているためです。

于 2009-08-08T08:36:18.863 に答える
1

一番下のステップのいくつかは、少し冗長です。それらを分割してみて、IF という単語が表示されないことを確認してください。IF は、菱形を使用し、条件に基づいてフロー パスを分割して指定する必要があります。

于 2009-08-08T08:43:12.217 に答える