Академический Документы
Профессиональный Документы
Культура Документы
RequirementOne ReqMan
Getting Started Guide v1.1
Table of contents
Introduction.......................................................................................................................................... 3
Using the Requirement module ........................................................................................................... 4
Concepts........................................................................................................................................... 4
General usage scenarios ................................................................................................................... 6
Using the User module....................................................................................................................... 10
Concepts......................................................................................................................................... 10
General usage scenarios................................................................................................................. 11
Using the Questionnaire module........................................................................................................ 12
Concepts......................................................................................................................................... 12
General usage scenarios................................................................................................................. 12
Using the Invitation To Tender module............................................................................................. 15
Concepts......................................................................................................................................... 15
General usage scenarios................................................................................................................. 16
Using the Reporting module .............................................................................................................. 19
Concepts......................................................................................................................................... 19
General usage scenarios................................................................................................................. 19
Using the Workflow module.............................................................................................................. 20
Concepts......................................................................................................................................... 20
General usage scenarios................................................................................................................. 20
Glossary ............................................................................................................................................. 21
Introduction
ReqMan is a web-based modular platform for developing requirements and electronically managing
the processes between different stakeholders. The platform consists of the following modules that
can be used either independently or together:
- Requirement module
- User module
- Reporting module
- Questionnaire module
- Invitation To Tender module
- Workflow module
The most important module is the Requirement module because it outputs vital information to most
of the other modules.
Before using these modules, you must select the project you are working on. Projects are
highlighted in red in the ReqMan menu.
A customer account can have a number of projects and each of these projects can have a number of
specifications. Each specification can have a number of requirements and the various modules are
used to create, maintain, view and communicate the data in these specifications.
You can always contact support if you have questions or comments: support@requirementone.com
1. Open a project.
2. Open the Requirement module.
3. Create a new specification.
4. Configure the specification.
5. Create your first requirement.
Before we continue with the detailed steps for configuring the Requirement module, there are a few
concepts that need to be explained.
Concepts
Account
One or more accounts are created for each customer. An account contains one or more projects.
Each account can have different themes (the “look and feel” of ReqMan), custom help texts and
labels shown in the user interface and the default culture used that dictates localized settings, such
as date and time formats.
Project
A project contains all of the ReqMan modules required to manage specifications, users, reports,
tenders and so forth for the specific project.
Requirement
A requirement is the most central entity on the ReqMan platform. The content of a requirement
depends on the context and industry, but it is typically used to describe an attribute to be possessed
by a product, a function to be performed by a product, a performance standard or a component of an
existing system. In ReqMan, there are many standard attributes that can be specified and logged for
each requirement such as unique references, names, details, stakeholders, notes, attachments and
change histories.
Specification
Table of contents
Tip: Although the table of contents can be changed throughout the project, it is recommended that
you create and structure as much of the table of contents as possible before you start to enter
requirements.
Custom field
Custom fields are attributes that can be used to store meta-data and they can be configured by the
user to be available either for specifications or requirements.
There are two different types of custom fields: free text and lists. The free text entry can be
validated by using regular expressions that require the user to type in a specific kind of entry, such
as integers, currencies, or other specific formats. The list definitions contain predefined selections
such as Priority: High, Medium and Low. Optionally, a list selection can allow multiple selections.
Custom fields that are used for requirements are configured for each specification and are available
for all requirements that belong to that specification. Typically, custom fields at this level are used
to store information about priority, implementation cost, reference ID, process state and so forth.
Custom fields that are used for specifications are configured at the project level and are available
for specifications that are created within the project. Typically, custom fields at this level are used
to store information about approval status, project manager and other high level information.
Note category
Note categories can be configured by the user for each specification and they are used to categorize
notes that are entered for individual requirements. Notes can be viewed as “Post-It” notes and the
categories are used to order the notes. Typical note categories could be internal notes, technical
notes, tenders notes, and so forth.
There are two system note categories that can not be changed: default and end-user dialogue. The
default category is used for notes where no category is specified. The end-user dialogue is used to
communicate with external stakeholders. Notes created in the end-user dialogue category are visible
to users that are assigned as stakeholders for individual requirements and the stakeholder responses
are also saved within this category.
Tip: When sending out requirements, using the Invitation To Tender module notes can be included
based on the category.
Attachment category
Attachment categories can be configured by the user for each specification and are used to
categorize files that are attached to individual requirements. Typical attachment categories could be
Internal files, Mock-ups, Test instructions, and so forth.
Tip: When sending out requirements, using the Invitation To Tender module attachments can be
included based on the category.
1. Log-in to ReqMan.
2. Expand your project in the tree menu.
3. Expand the Requirement module in the tree menu.
4. Click specifications.
5. Click “New specification”.
a. Type in the name “My first specification”.
b. Click save.
c. Click “My first specification”.
6. Click “Table of contents”.
a. Type in the name for the first section: “General requirements”.
b. Click “Create node” (section).
c. (Optional) Add more nodes.
d. Click back.
7. Click “Custom fields”.
a. Type the name: “Priority”.
b. Select type: “List of values”.
c. Add the values: High, Medium and Low.
d. Click insert.
e. Click back.
8. Click “Note categories”.
a. Type the name: “Internal notes”.
b. Click insert.
c. Click back.
9. Click “Attachment categories”.
a. Type the name: “Internal files”.
b. Click insert.
c. Click back.
You have now setup your first specification. You can modify the configurations as you work with
your project.
Create your first requirement and send it out for review to a stakeholder:
1. Log-in to ReqMan.
2. Expand your project in the tree menu.
3. Expand the Requirement module in the tree menu.
4. Click specifications.
5. Click “My first specification”.
6. Click “New requirement”.
7. Fill in details for the requirement:
a. ID: Any value that is unique within the project.
b. Name: Brief description of the requirement. For example, “Word report”.
c. Details: Details for the requirement. For example, “The system shall support Word
reports.”
d. Status: Select a status for the requirement. The status values are used to control what
response is required from the end-user. If you specify “pending approval of final
requirement”, the stakeholder can select “Yes”, “No” or “Yes if” and provide a
comment. If pending more information is specified, they can provide a comment.
The detailed behaviour of the status transitions can be configured for each
specification.
e. TOC (Table of Contents): Select where in the table of contents the requirement
should be stored. For example, “general requirements”.
f. Requirement links: When the requirement has been saved, you can add links to other
requirements that this requirement depend on and specify the relationship between
the two: parent, child or bi-directional.
g. Notes: You can add one or more notes to the various note categories.
h. Attachments: You can upload one or more files. Each attachment should have a
name and description specified.
i. Custom fields: You can select values for the various attributes that you have
configured for the specification.
j. Created from questionnaire: If the requirement was created as a result of a
questionnaire from the Questionnaire module, a link to that questionnaire appears
here.
k. Save: If the requirement has been saved at least once, you can check “Intermediate
change” which is used if minor changes are made like copy edits. Minor changes can
then be excluded when making reports or doing analysis.
l. Change history: The change history for each requirement keeps a log of all changes
to all values for each requirement. The changes are categorized and can easily be
filtered.
In the next scenario, you learn how to search for your requirements by using various filters.
The next scenario shows you how to batch update a selection of requirements. When you have
performed a search as described in the scenario “Search for requirements”, you can select
requirements to be batch updated through various actions, such as move requirements, update
custom fields and so forth.
with whatever action you choose. You can also edit your selection by clicking edit or you
can click one of the batch update actions listed below the basket.
11. When you select one of the “batch update actions” to be carried out for the selected
requirements in the basket, then the requirements chosen are listed as are the specific update
options for the particular action.
In the next scenario, you learn how to perform traceability analysis of your requirements.
Shows you a grid with a record for each requirement in the current specification and
a column for each requirement that these requirements are linked to. The types of
relationship are listed for each link.
• Custom fields
Lets you select a custom field for the current specification. The result will show a
grid with a record for each requirement in the current specification and the value
selected for the respective custom field.
The results are scrollable both vertically and horizontally. You can also export the entire
gird to Microsoft Excel if you want to view the entire grid at one time.
Detailed user permissions can be setup in the context of the current project. Please note that
permissions are inherited which means that permissions set at the project level will automatically
grant the user at least the same permission at lower levels.
Concepts
Users in ReqMan follow a unique business model in which a single user can use the entire ReqMan
platform free of charge. Furthermore, your user login enables you to participate in any project, for
any organization, as long as you have the required permissions to do so.
User profile
The profile for each user includes contact information and user specific configurations, such as the
time zone and culture, which dictates, for example, number and date formats.
Time zone
The time zone setting for each user determines how all timestamps are shown in the user interface
for that particular user.
User groups
User groups can be created in a tree hierarchy for each project. Users are then assigned to one of the
user groups.
Permissions
The ReqMan platform contains an elaborate permission model in which all entities (project,
specifications, requirement, and so forth.) have permissions directly defined for each user or
through inheritance. Permission inheritance is based on the principle that if you have access to an
entity at a certain level, then you should also have access to all entities at lower levels than that
entity. For example, if you have access to a specification, then you would inherit access to all
requirements that are contained within that specification. For each permission, the level of
permission is specified as read or write.
The user has now been added to the project and can be assigned to requirements.
The next scenario shows you how you can manage permission for a newly created user.
The permissions that are currently assigned to the user are listed. When a user is first
created, there are no permissions assigned. You can assign permissions at different levels:
Project, Specification and Requirements.
10. You can select if the current user should have read or admin (write) access to the respective
specifications.
Tip: Because of inheritance, permissions added for the specification are automatically
applied to all of the requirements in that specification. Typically, a stakeholder only has
access to requirements and not to the entire specification or project.
11. Click save.
12. Click cancel.
Concepts
Questionnaires
Questionnaires in the Questionnaire Module can consist of a list of questions. The response options
can be configured to be either free text or a pre-defined list of options. Questionnaires can be
configured to allow them to be submitted just once per user or multiple times per user.
Groups
Questionnaires are organized in groups so that you can logically organize your questionnaires and
control what users have access to them based on group permissions. Each group has a list of
recipients specified.
Recipients
Recipients are one or more users that are selected to receive an invitation to submit the
questionnaires in one of the groups.
Parse submissions
Submissions received by the individual users can be filtered and parsed. If users submit long
answers consisting of many paragraphs that need to be split into multiple requirements, then the
subsections of text can be selected and requirements in the Requirement Module can be created
(with full traceability).
Traceability
Requirements created based on the individual user submissions contain an electronic link back to
the original user submission, questionnaire and specific subsection of the text submitted for full
traceability.
Tip: Typically, if you gather profile information (name, contact details and so forth),
you only let the user submit the form once. If you gather requirements suggestions,
you would typically let the user submit the form multiple times.
h. Attachments: You can upload attachments that can provide additional information to
the users about how they should submit the questionnaire.
8. Click save.
9. Click Manage questions.
10. Questions on the questionnaires are organized in groups. Type in a questionnaire group
name. For example, “Requirement details”.
11. Add questions:
a. Question group: “Requirement details”
a. Question text: “Details”
b. Mandatory: Select this option to make answering the question mandatory.
c. Select type: Free text, drop down list, checkbox list or upload file.
If you select either of the list types, please also type in an option per line in the text
box.
g. Select type: Drop down list, specify options: High, Medium and Low.
h. Click save.
12. Click preview. Click manage questions if you want to change the existing questions or add a
new question.
13. Click Send selected invitations.
14. Select Send selected invitations and select the users that should be invited.
15. Click send.
Tip: You can create a questionnaire for different types of requirements that you want to gather. For
example, “General requirements”, “Reporting Requirements” and so forth. Each questionnaire is
then configured with the target specification and table of contents section where the suggestion
should be placed.
In the next scenario, you learn how to respond to an invitation sent out from the questionnaire
module.
In the next scenario, you learn how to parse the received submissions and create requirements.
A requirement has now been created based on this submission and an electronic link has
been created between the specific submission and the new requirement.
Concepts
Tender
A tender is a logical container that holds all the information related to a tender that needs to be
communicated to one or more vendors. The tender has the overall start and end dates defined and it
contains one or more iterations.
Iteration
Iterations are logical containers that exist within a tender that contains one or more questionnaires
including a list of users. The iteration has a start and end date. If you need users to respond to the
same requirements multiple times, for example when you have multiple negotiations rounds, then
you can create an iteration per negotiation round. The Invitation To Tender module has various
types of analysis you can apply to the different responses.
A requirement based questionnaire contains a list of requirements that you select from the
Requirements module. You then create one or more questions and these questions are then repeated
for each requirement that you have selected.
“Regular” questionnaire
A regular questionnaire contains one or more questions to which the user can either reply with a
free text answer or with a selection from a predefined list.
Browse and edit is an interface that is available to review all the data submitted by users
participating in the various iterations. This interface can also be used to specify comments for the
individual replies.
Analysis: Quantitative
Quantitative analysis is used to sum up questionnaire answers received from users for a certain
iteration. It could, for example, be used to isolate answers when users select if they were compliant,
“Yes” or “No”, if prices were specified by users, and so forth. Afterward, the total statistics for the
different questionnaires and users are immediately available in a graphical format and exportable to
Microsoft Excel.
Analysis: Qualitative
Qualitative analysis is based on a detailed evaluation of each reply to a requirement. The replies are
reviewed and can then be scored using any best-practice system. This score can then be compared
to the quantitative analysis and this provides the basis for a drill down to the data of interest.
In the next scenario, you learn how to create questionnaires to include in your iteration.
Create questionnaire(s):
1. Log-in to ReqMan.
2. Expand your project in the tree menu.
3. Expand the Invitation To Tender module in the tree menu.
4. Click Tenders.
5. Click one of the tenders that you have created.
6. Click one of the iterations that you have created.
7. Click new questionnaire.
8. Fill in header information for the questionnaire:
a. Name: “My first requirements”
Version 1.1 Page 16 of 21
RequirementOne Inc. All Rights Reserved
RequirementOne ReqMan: Getting started guide
You are now transferred to a page where you can select which requirements to include on
your questionnaire.
If you select either of the list types, please also type in an option per line in the text
box.
Tip: You can also invite users using Invitation To Tender -> Tenders -> Iteration -> Send
Invitations.
In the next scenario, you learn how to review the responses received.
Do analysis (Beta):
The analysis pages are currently available in a beta version. These will be extended with a number
of different types of analysis packages forwarding the future.
1. Log-in to ReqMan.
2. Expand your project in the tree menu.
3. Expand the Invitation To Tender module in the tree menu.
4. Click Analysis (BETA).
5. You can select the Tender, Iteration and Questionnaire.
6. Select a specific question that contains a numeric value, such as Price.
7. Select which custom field in the specification that you want to compare the prices reported
by the users to. For example, this could be a base line price.
In this case, the result would include a graphical overview of the user prices and the baseline
price for your requirement.
The Reporting module supports a generic transformation language that can be used to generate
reports in almost any data format.
Concepts
Report
A report is the result of selecting data from one of the ReqMan modules and applying a
transformation. Examples include a Word document containing a requirement specification, an
Excel document containing vendor responses received through the Invitation To Tender Module or
a text based file that can be imported into a third-party application.
Filters
A filter is one or more criteria that are specified to limit data included in a report. For example, a
filter could be all requirements that are tagged as priority 1 (custom field) and have been updated
(time stamp) within the past 2 weeks.
The XSL language is used to iterate through the generic data that has been selected and filtered. The
language contains a variety of options for manipulating and saving the data in almost any format.
Generate a report
1. Log-in to ReqMan as one of the users that received the invitation.
2. Expand your project in the tree menu.
3. Expand the Reporting module in the tree menu.
4. Click Reporting Manager.
5. Select one of the reports that are available to you.
6. Click export.
Custom reports can be developed in cooperation with the RequirementOne Professional Services
team. Contact support@requirementone.com for more information.
Concepts
Workflow
Activity: Generics
Activity: ReqMan
ReqMan activities include creating requirements, creating users, waiting for a questionnaire to be
submitted, creating a report and most of the other functions available on the ReqMan platform.
Glossary
Attachment File attached to a requirement.
Attachment category Categories are used to organize requirement attachments. Configuration is done at the
specification level.
Custom field Field that is a text- or list field. Configuration is done at the specification level.
Dashboard Dashboards are available throughout ReqMan and are used to visualise summarized
information from the various modules.
Invitation To Tender The ReqMan module that contains functionality to create tenders, iterations,
Module questionnaires and to receive replies from multiple external stakeholders and to carry
out qualitative and quantitative analysis on the submitted data.
Iteration An iteration (or negotiation round) belongs to a tender and is used to store
questionnaires. Replies to questionnaires in different iterations can be compared to
each other.
Module A module is a group of related functions in ReqMan. Modules are listed below each
ReqMan project.
Note Note added for a requirement.
Note category Categories are used to organize requirement notes. Configuration is done at the
specification level.
Permission A permission is a read or write setting that defines a user’s rights to view or alter a
ReqMan entity.
Project A project is the ReqMan entity that contains modules.
Question A question is a control that is typically a text box or list where stakeholder can provide
an answer.
Questionnaire - A regular questionnaire is a group of questions that is sent out to one or more
regular stakeholders.
Questionnaire - A requirement-based questionnaire is a questionnaire in which you list requirements
requirement based and, for each requirement, a set of questions is repeated.
Questionnaire Module The ReqMan module that contains functionality to create regular questionnaires to
gather information from external stakeholders, parse the submissions and convert them
to requirements.
Reporting Module The ReqMan module that contains functionality to generate different types of reports for
the content in the various modules.
Requirement A statement of something that is wanted or needed.
Requirement Module The ReqMan module that contains functionality to organize requirements in
specifications and carry out analysis.
Specification A specification is a container used to organize requirements. A specification contains
individually configured tables of contents, custom fields, attachment categories and
note categories.
Stakeholder A stakeholder is one who has a stake or interest in the outcome of a project.
Table of contents The table of contents is a hierarchical structure that is used to organize requirements
(TOC) inside a specification.
Tender A tender is a container used to organize iterations.
Term Explanation.
User A user is a person that has a login to ReqMan.
User Module The ReqMan module that contains functionality to organize users in groups and to
manage their permissions.
Workflow A workflow is a logical process that consists of ReqMan activities, such as creating
requirements, submitting questionnaires, and so forth.
Workflow Module The ReqMan module that contains functionality to run and build business workflows.