User Guide for the Requirements Engineering Plug-In
  1. Describing Requirements
  2. Forms
    1. Common Properties
    2. Properties For <<use case desc>> And <<secondary used case desc>>
    3. Properties For <<use case desc>>
    4. Properties For <<req desc>>
  3. Customization Of the Predefined Values


Chapter 1 - Describing Requirements

The requirements of a system are described with a use case diagram, and each requirement is described with a use case. The following stereotypes can be attached to a use case:

<<use case desc>>
    Used to describe a high level use case.

<<secondary use case desc>>
    Used to describe a low level system use case that can't be used on its own and that needs to be included in a high level use case.

<<req desc>>
    Used to describe a requirement. Dependencies to this use case document the fact that the dependent use case must satisfy this requirement.



Chapter 2 - Forms

The requirements plug-in provides a form for each type of use case.


Common Properties

The following properties can be entered for each use case type:

ID
   An automatically-generated unique ID for the use case.

Responsible
   Name of the person responsible for the use case.

Creation date
   Creation date of the use case.

Last changed by
   Name of the last person changing the use case.

Last change date
   Date of the last change.

Stakeholders
   List of stakeholders.

Priority
   Priority of the use case. The predefined values for this property can be customized to fit the user's needs.

Realization date
   Date when the use case was realized.

Effort
   Effort needed or estimated for the use case.

Liabililty
   Liability of the use case. The predefined values for this property can be customized to fit the user's needs.

Excluded
   Determines if the requirement is excluded from the current project scope.

Status
   Current status of the requirement. The predefined values for this property can be customized to fit the user's needs.


Properties for <<use case desc>> and <<secondary used case desc>>

Essential Steps
   Describes the essential steps of the use case. The 'Generate Activities' button creates an activity diagram from this text, where each text line is mapped to an activity.


Properties For <<use case desc>>

Trigger
   Event that triggers the use case.

Precondition
   Precondition for the use case.

Result
   Result of the use case.

Postcondition
   Postcondition for the use case.


Properties For <<req desc>>

Requirement Type
   The type of the requirement (e.g. functional or non-functional). The predefined values for this property can be customized to fit the user's needs.

Scope
   The scope of the requirement (e.g. global or collaboration). The predefined values for this property can be customized to fit the user's needs.



Chapter 3 - Customization Of the Predefined Values

The predefined values for the liability, priority, state, type, and scope properties can be customized via the requirements-config.xml file, which must be stored in the user's Poseidon configuration directory. The root element is req-config and this element contains list elements for each property type, the type is given by the name attribute. The possible values are defined with li elements. The content of this element is the value, a default attribute marks this value as default for this property.

Default requirements-config.xml


<?xml version = '1.0' encoding = 'iso-8859-1' ?>
<req-config>
  <list name="liability">
     <li default="">Required</li>
     <li>Optional</li>
     <li>Intention</li>
     <li>Proposal</li>
     <li>Request</li>
     <li>Comment</li>
   </list>
   <list name="priority">
     <li>High</li>
     <li>Moderate</li>
     <li default="">Low</li>
   </list>
   <list name="state">
     <li default="">Received</li>
     <li>Audited</li>
     <li>Processing</li>
   </list>
   <list name="reqType">
     <li>Functional</li>
     <li default="">Non-functional</li>
   </list>
   <list name="scope">
     <li default="">Global</li>
     <li>Collaboration</li>
   </list>
</req-config>



© 2000 - 2010 Gentleware AG
         
                        
 support  documentation  req. engineering plug-in