System AdministratorRequirements management

Author: System Administrator Displayed: 13141
Created: 29/10/2015 Updated: 13/08/2019
Version: 35
Tags: requirements

How to use Requirements management

The video tutorial

Requirements management is useful for technically sophisticated projects where lots of small components and details build a big and impressive product (like a car or a piece of machinery).

Roles and permissions

An administrator can configure user permissions related to the plugin for any user role in Administration » Roles and permissions » select a role » Requirements.

Easy Redmine 2018 Requirements management 01.jpg

How to activate the plugin

Requirements management is a project module so it has to be enabled when creating a new project or in Settings » Modules of an existing project.

Easy Redmine 2018 Requirements management 02.png

How to use the plugin

When the plugin is activated on a project, go to the "Requirements" tab in the top menu of the particular project. For the first time, you will be asked to review the plugin configuration for this particular project. In Artifact configuration, you can select which of the three existing artifacts (Section, Requirement, Change request) will be used, rename them if needed and assign them specific colors for a better overview. These artifacts represent basic attributes in the requirements' tree structure. Neither adding nor deleting types of artifact is possible, only editing the parameters of the existing ones.

In Relationship configuration, you can define possible relations between the artifacts, such as which one precedes ("Use" or "Incoming relationship") or follows another one ("Directed" or "Outgoing relationship"). You can name the relation, assign it a color and add or delete any. To restore default values of the configuration, click the "Cancel" button down on the page. When finished, you have to click "Save" button before proceeding to the next step. Anytime later, you can return to this configuration by clicking "Configure Plugin" button on the basic page of the plugin.

In Status configuration, you can add or remove requirement status, such as New, In Realization, Done, etc. When a requirement has a status, this status can be seen in the tree structure as displayed next to the requirement name as well as inside each requirement. For each status, a specific color can be selected using a color palette or hexadecimal code.

Easy Redmine 2018 Requirements management 03.jpg

Down on the page is the Artifact import/export option.

Easy Redmine 2018 Requirements management 11.jpg

To import one or more artifacts including their attributes and custom fields, simply use an Excel sheet where the names of the variables (such as id, artifact_type, project_id, etc.) are identical with the names of the columns in the first line of the sheet. Each next line represents another single artifact with its attributes. Importing an artifact of the same name as already existing one will add/rewrite its attributes with the imported ones.

If you are not sure how the Excel sheet structure should look like, simply click the Export button, which creates and downloads an Excel file template where you can simply add your data and import back. Obviously, this file can also be used to migrate your existing artifacts into another Easy Redmine instance just like a different project management software.

Easy Redmine 2018 Requirements management 12.jpg

After successful saving of the configuration page, click again the "Requirements" tab in the top menu. Now you should see the basic page of the plugin with a description of artifacts and tutorials in the middle section where you can learn more.

In order to start defining the requirements, you see a project name in the left sidebar. Here you can start building your requirement structure such as sections which are further broken down into requirements. Instead of section and requirement, you can use a different naming convention like chapter and specification - types of artifacts are customizable. You can right-click on any artifact in the tree structure to add new artifacts. Use "create artifact in" to create an artifact in the deeper level of the tree or "create artifact below" to create an artifact on the same level. Just note that the highest level is always the project itself so you cannot create an artifact on the project level. The structure can be as deep as you need.

Easy Redmine 2018 Requirements management 05.png

When creating an artifact, choose a responsible person, enter a description, you can also add related issues (tasks), add comments and file attachments as well.

Easy Redmine 2018 Requirements management 06.png

Related issues (tasks) can be added/created directly from requirements and the new task will automatically be connected to the requirement.

Easy Redmine 2018 Requirements management 07.png

Or you can select related artifacts straight on a standard New task creation form and also when editing an existing task. When you are finished with the requirement settings, just save it.

Easy Redmine 2018 Requirements management 08.png

The list of related requirements can also be found when you open a particular related issue (task).

Easy Redmine 2018 Requirements management 10.png

If you go to the requirement detail, you can see all connected issues (tasks) along with their status so you have a good overview of how close you are to achieving it. Using the buttons above and below the detail window, you can update or unwatch the requirement (disable e-mail notifications about changes made), connect related issue (task) and delete the requirement.

Easy Redmine 2018 Requirements management 09.png

How to add a custom field

To add a custom field to your requirements artifact, go to Administration > Custom fields > New custom field > select Requirements. Then follow the standard custom field creation procedure.

Easy Redmine 2018 Requirements management 13.jpg

Add picture from clipboard