25
[email protected] ReqView Create and Review Structured Requirements Documents version 0.13

Create and Review Structured Requirements

  • Upload
    eccam

  • View
    1.699

  • Download
    2

Embed Size (px)

Citation preview

Page 1: Create and Review Structured Requirements

[email protected]

ReqViewCreate and Review Structured

Requirements Documents

version 0.13

Page 2: Create and Review Structured Requirements

Structured Requirements Definition

ReqView - Create and Review Structured Requirements Documents

© Eccam 2

Rich formatted description

Custom attributes

Unique ID

Discussion

Tree

Hierarchy

Requirement

Traceability

Links

Requirements

Document

Project

Documents

Page 3: Create and Review Structured Requirements

Requirement Attributes

ReqView - Create and Review Structured Requirements Documents

© Eccam 3

Requirement

Basic

Priority

VerificationCollaboration

Planning

• Unique ID

• Description

• Type

• Urgency

• Severity

• Acceptance Criteria

• Verification Method• Discussion

• Status

• Target Release

• Risk

• Effort

Page 4: Create and Review Structured Requirements

Requirements Hierarchy• Requirements structure usually corresponds to

decomposition of the developed product into features

• Complex systems need also further requirements decomposition to several levels (e.g. user requirements, system requirements, …)

ReqView - Create and Review Structured Requirements Documents

© Eccam 4

Page 5: Create and Review Structured Requirements

Requirements Traceability• Reference links

between requirements

• Verification linksfrom related tests

• Satisfaction links from decomposedrequirements

• Implementation linksfrom user stories

ReqView - Create and Review Structured Requirements Documents

© Eccam 5

Page 6: Create and Review Structured Requirements

Requirements Management in MS Office

+ Hierarchical structure given by Word sections

- Additional attributes can be described only by a free text

- No unique ID, no traceability

+ Attributes as additional columns - filtering and sorting

+ Traceability matrix

- No hierarchical structure

+ Hierarchical structure + attributes + traceability

- Reasonable manual effort needed for ensuring consistency

ReqView - Create and Review Structured Requirements Documents

© Eccam 6

Page 7: Create and Review Structured Requirements

Requirements Management Tools

• Robust solution for complex systems

• Multilevel traceability analysis

• Integrated requirements version control

• Integration with quality and change management

• Online web client for edit and review

• Expensive, difficult to set up, too complex for small projects

• Online connection to the RM tool server needed

• Availability and performance issues

ReqView - Create and Review Structured Requirements Documents

© Eccam 7

Page 8: Create and Review Structured Requirements

Requirements Management in ReqView

Take the best from both MS Office and specialized requirements management tools

• Open document format

• Rich content with images

• Custom attributes

• Team discussions

• Traceability links

• History tracking

• Works offline

ReqView - Create and Review Structured Requirements Documents

© Eccam 8

Page 9: Create and Review Structured Requirements

ReqView Solution Components

ReqView - Create and Review Structured Requirements Documents

© Eccam 9

Page 10: Create and Review Structured Requirements

ReqView Open Document Format• Own your data

• Integrate easily withown proprietary tools

• Human readable– Based on JSON

– Compare easily twodocuments

– Store in a version control system (SVN, GIT)

• Strong encryption

ReqView - Create and Review Structured Requirements Documents

Check Documentation

© Eccam 10

Page 11: Create and Review Structured Requirements

ReqView Desktop• HTML5 application for editing and reviewing

requirement documents

• Available as offline Chrome Application or as Web Application

• Runs on any desktop PC and we plan to support also tablets

ReqView - Create and Review Structured Requirements Documents

© Eccam 11

Install

> 1000 users

Page 12: Create and Review Structured Requirements

ReqView SynchronizerSupporting command line tool

• Import and export CSV files

• Import of ReqIF documents from RM tools

• Decryption and encryption of ReqViewdocuments

ReqView - Create and Review Structured Requirements Documents

© Eccam 12

$ synchronizer ––import -f reqif -i UserNeeds.reqif-o UserNeeds.reqw -c config.json -p password

Download

( Login needed )

Page 13: Create and Review Structured Requirements

Browse Requirements Structure

ReqView - Create and Review Structured Requirements Documents

© Eccam 13

Table of Contents

Generated unique ID

Section number

Section heading

Rich text description

Search and filter

Page 14: Create and Review Structured Requirements

Edit Requirements• Edit requirement text using inline Rich Text Editor

• Enhance requirements with embedded images or attached files

ReqView - Create and Review Structured Requirements Documents

© Eccam 14

Page 15: Create and Review Structured Requirements

Customize Requirement Attributes

ReqView - Create and Review Structured Requirements Documents

© Eccam 15

Custom attributes summary column

Custom attribute value editor

Page 16: Create and Review Structured Requirements

Customize Traceability Links

ReqView - Create and Review Structured Requirements Documents

© Eccam 16

Explore requirement links

in Links column

Page 17: Create and Review Structured Requirements

Review Requirements• Change user defined requirement status

• Requirements discussion

ReqView - Create and Review Structured Requirements Documents

© Eccam 17

Discussion column

Statuscolumn

Page 18: Create and Review Structured Requirements

Filter, search and sort requirements

ReqView - Create and Review Structured Requirements Documents

© Eccam 18

Full Text Search

Intelligent Filter

Page 19: Create and Review Structured Requirements

Track Changes• ReqView automatically keeps history of each

requirement attribute change

ReqView - Create and Review Structured Requirements Documents

© Eccam 19

History of selected requirement

Requirement change

Page 20: Create and Review Structured Requirements

Compare Document Versions• Store unencrypted

ReqView document in a version control system (SVN, GIT, Mercurial, …)

• Compare changes between document versions

ReqView - Create and Review Structured Requirements Documents

© Eccam 20

Page 21: Create and Review Structured Requirements

Share Requirements Online• Open document from Google Drive

• Save document or update document on Google Drive

ReqView - Create and Review Structured Requirements Documents

© Eccam 21

Page 22: Create and Review Structured Requirements

HTML CSV ReqIF *

Tree hierarchy Yeshierarchy given by paragraph styles

Yeshierarchy given by

level attribute

Yes

Rich text format Yes No Yes

Images Yes No Yes

ID No Yes Yes

Custom attributes No Yes Yes

Traceability No No Planned

Import from MS Word MS Excel, DOORS DOORS

* ReqIF is OMG standard for requirements exchange

Import Requirements Document

ReqView - Create and Review Structured Requirements Documents

© Eccam 22

Page 23: Create and Review Structured Requirements

Export Requirements Document

ReqView - Create and Review Structured Requirements Documents

© Eccam 23

HTML CSV

Tree hierarchy Yeshierarchy given by paragraph styles

Yeshierarchy given by

level attribute

Rich text format Yes No

Images Yes No

ID Yes Yes

Custom attributes Yes Yes

Traceability No No

Export to MS Word MS Excel, DOORS

Page 24: Create and Review Structured Requirements

ReqView Future Directions• Project consisting of multiple documents

– Switch between edited documents

– Traceability between documents

• Advanced filtering

• Document templates for agile, use cases, BDD

• Integrations

– ReqIF Roundtrip Synchronization with DOORS

• UI optimized for tablets

ReqView - Create and Review Structured Requirements Documents

© Eccam 24

Vote for New Features

Page 25: Create and Review Structured Requirements

ReqView References• ReqView Homepage

http://www.reqview.com

• ReqView Desktop Online http://www.reqview.com/apps/desktop/ReqViewDesktop.html

• ReqView Desktop at Chrome Store https://chrome.google.com/webstore/detail/reqview-desktop/cmbnhmeabefpflildnahpbghcejkblin

• Support Site - online help, knowledge base and discussion forumhttp://support.reqview.com/solution/categories

ReqView - Create and Review Structured Requirements Documents

© Eccam 25