Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

Overview

Some preparation is needed to successfully use R4J Cloud. We recommend reviewing the following sections and taking any necessary actions to ensure a smooth start.

Your Jira system administrator can work with you to adapt the Jira configuration. If Jira is shared with other projects, you should align the necessary changes with them. We recommend starting small and simple. Future extensions are much easier than complex adaptation at a later time.

Issue Types

R4J Cloud reuses the issues types defined in Jira. We suggest you create the following types:

Folder

To allow you the most flexibility, R4J Cloud does not provide a built-in type for folders. You should create a type to organize requirements into hierarchical structures. Make sure to configure a folder issue type for your requirements tree.

Customer Requirement

It is often useful to distinguish between requirements from external sources (e.g. the customer's user stories) and internal sources (e.g. the detailed specifications derived from customer requirements).

Functional Requirement

These are internal system and component specifications that are derived from customer stories.

Non-Functional Requirement

These are specifications that are not directly related to customer stories.

Task

It can be useful to break down requirements into detailed implementation tasks for development teams.

Test Case

It is often valuable to have explicit test cases corresponding to the requirements, depending on the testing strategy and the desired granularity of test cases.

The suggested issue types and names are not required by R4J Cloud. Depending on your methodology you can have other issue types or names.

Workflows

Any workflows you design for your issue types can be used with R4J Cloud. Think about your approval and acceptance process as you are defining one or more flows for different requirement types. Start with simple steps your teams can follow easily.

Fields

R4J Cloud uses a number of Jira fields to display the content of a requirement:

Issue Key

The unique identification of requirements in the project tree, used to open the Jira issue view and navigate through the tree.

Summary

The headline of a requirement, used in the tree and detail views.

Description

The detailed content of a requirement, most prominent in the detail view.

Linked Issues

Related issues, including the type of the relation.

Attachments

Images or other sorts of content added to the requirements. Images can be used in the description field to illustrate the content.

Comments

A convenient way to discuss the content and state of requirements with colleagues.

Other Jira system fields

Fields displayed in the detail view if values are provided.

Custom fields based on built-in field types

Fields displayed in the detail view if values are provided.

Custom fields based on field types introduced by other apps

Fields displayed in the detail view if values are provided.

Due to the application-specific functionality of the field types introduced by other apps, their expected behavior cannot be guaranteed in R4J views.

Link Types

For the sake of traceability it is important to have the right link types in place. The link types provide the relations that are necessary to get valuable results from the R4J Cloud Coverage and Traceability Views. The following link types, with suggested outgoing and incoming names, are recommended:

relates to

A bidirectional relation, built into Jira. It should be used carefully to avoid misinterpretation.

clones

is cloned by

Important for reusability to indicate the relation between the original and copied requirement.

duplicates

is duplicated by

Can be used to indicate the existence of requirements with the same meaning but different wording.

trace to

trace from

Indicates the relation between customer requirements and detailed specifications.

tests

tested by

Relates test cases to the corresponding requirements.

The first three link types are installed in Jira by default. The last two recommended types (and any others required by your projects), should be created.

  • No labels