web-dev-qa-db-ja.com

ビジネスルールを文書化する方法

ビジネスルールを文書化する正式で最も一般的に行われている方法は何でしょうか。また、開発成果物のUI仕様をどのように文書化しますか(例:フォームフィールドの文書化、フォームでのボタンの動作、情報テキストなど)

12
Maro

ビジネスルールについては、@ Joppeが私たち全員が考えていたUMLを指摘したと思います。

ユースケース図は、アクター/ロールがシステムとどのように相互作用するか、およびシステムが何をするかの優れた概要を示します。複雑なユースケースの場合、テキストで説明された追加情報が役立ちます(前提条件事後条件以前のUC実行への依存etc

さまざまなレベルでのビジネスの概要も示す図があります。

  • 状態マシン図 文書化する状態の種類がある場合。
  • アクティビティ図 。複雑なユースケースの場合、詳細に入る必要があるかもしれません。詳細のレベルはあなた次第であり、誰がドキュメントを読むかによって異なります。これはビジネスのようなドキュメントには見えないかもしれませんが、適切なレベルの詳細があれば、そうなる可能性があります。

アドバイスとして、各ユースケースにコードを割り当てます(例:C-1C-n)。これらは、後でUIのドキュメント化の際に役立ちます。

UIドキュメントの一般的な方法(最近)は wireframes を実行することです。見た目がすっきりとシンプルなので、スクリーンショットよりもはるかに優れています。たとえば、 WireframeSketcher を見てください。

ワイヤーフレームだけでは十分なドキュメントではない可能性があるため、各画面について簡単な説明を行い、すべてのボタンについて説明します。さらに、画面に含まれるUCへの参照を行います(Cコードが役立つ理由を参照してください)。これにより、ドキュメントに一貫性が生まれます。

Wireframesketcherなどのツールのポイントは、インタラクティブなモックアップを行うことです。あなたがまだ設計または開発している間に、顧客にインタラクティブな何かを与えるのに最適です。

ナビゲーション計画を文書化することを忘れないでください。ナビプランにはUMLダイアグラムがありませんが、代わりに State Machine Diagram を使用できます。それはそれが作られたもののためではなく、まだです。

最後に、あなたが誰に宛てているのかを覚えておいてください。

  • 技術者:詳細に進み、技術を使用できます。

  • 技術者ではない:(languajeにもコードにも関連しない)技術を回避します。明確でシンプルなものにし、お客様が使用しているのと同じ用語/単語を使用するようにします。プログラミングのアイデアがなかったように思います。

1
Laiv

文書化は、ユースケースや他の散文形式で行われることがよくあります。さらに、より高いレベルで概要を示し、ページやページを読むよりも短時間で簡単に理解できるUMLダイアグラムやその他のグラフィックフォームを用意すると非常に便利です。

そして最後に、最も重要なドキュメントは、ビジネスルールを実行するテストケースです。これにより、コードを変更して、ビジネスルールに違反していることがわかります。それ以外の場合、ドキュメントは常に古くなって古くなるという危険にさらされています。

5
Manfred Moser

おそらく最も一般的な形式は ユースケース です。画面のモックアップと説明を追加できます。

私がお勧めする本は、Alistair Cockburnによる「Writing Effective Use Cases」です。さまざまな詳細レベルでユースケースを作成する方法、「テンプレート」主導のアプローチに陥らないようにする方法、および必要な関連ビットの文書化に固執する方法について説明します。

4
Joppe

どの方法を使用する場合でも、それらを積極的に保守できるようにしてください。彼らは生きた文書でなければなりません。ドキュメントをバージョン管理システムまたはSharepointのようなドキュメント管理システムに収容することは、ドキュメントを維持するのに大いに役立ちます。電子メールに添付されたWord文書を通じてビジネスルールを追跡することは、複数のバージョンが浮かんでしまうため、この問題に対処する恐ろしい方法です。

2

ビジネスルールをユースケースやUIデザインから参照するだけで、ビジネスルールをシステム仕様から厳密に分離することを強くお勧めします。私のお気に入りのテクニックは次のとおりです。-識別されたビジネスルールのリストをスプレッドシートに入れます。 -システム設計、ユースケース仕様、ユーザーストーリーなどで、「ユーザーがビジネスルールBR012で指定された情報を入力する」、「システムがビジネスルールBR510で指定された合計金額を計算する」と指定するだけです。私はこの記事をお勧めします http://www.allaboutrequirements.com/business-rules/

0
Hakim