NewSysRS User Instructions

Complete guide to using NewSysRS Requirements Management System for Jira

Table of Contents

Overview

NewSysRS is a comprehensive requirements management system designed as a Jira Connect app. It provides powerful tools for organizing, tracking, and managing requirements throughout your project lifecycle. The application integrates seamlessly with Jira, allowing you to maintain traceability between requirements and your development workflow.

Key Benefits

  • Hierarchical Requirements Organization: Structure requirements in logical hierarchies
  • Specification Management: Organize requirements into folders and specifications
  • Traceability: Track relationships between different requirement levels
  • Coverage Analysis: Analyze requirement coverage across different dimensions
  • Collaborative Reviews: Enable team collaboration on requirement validation
  • Jira Integration: Seamless integration with your existing Jira workflows

Getting Started

Installation and Setup

  1. Install the App: Install NewSysRS from the Atlassian Marketplace
  2. Initial Configuration: Access the app from Jira's navigation bar under "NewSysRS - Requirements"
  3. Project Setup: Configure your first project settings and artifact types

First Steps

  1. Navigate to Project Settings to configure:
    • Artifact types (requirements, specifications)
    • Review workflows
    • User permissions
  2. Create your first Specification Folder to organize requirements
  3. Add Requirements linked to Jira issues

Project Settings Overview

NewSysRS Project Settings

Configure your project settings to define artifact types and workflows

Core Features

Requirements Management

Creating Requirements

  1. Navigate to Specifications: Access the specification view from the main menu
  2. Add New Requirement:
    • Click the "+" button or right-click for context menu
    • Select "Create New Requirement"
    • Link to existing Jira issue or create new one
    • Set hierarchy level (parent, child, sibling)

Managing Requirement Hierarchy

  • Add Child Requirements: Select a requirement and choose "Add Child"
  • Move Requirements: Drag and drop or use "Move" option in context menu
  • Change Levels: Use "Promote" or "Demote" to adjust hierarchy levels
  • Copy Requirements: Use "Copy" to duplicate requirements across specifications

Specification Management

Specification Structure Example

Specification Structure

Example of hierarchical specification organization with folders and requirements

Folder Structure

  1. Create Folders: Organize specifications in logical folder structures
  2. Nested Organization: Create sub-folders for complex project hierarchies
  3. Folder Management: Rename, move, or delete folders as needed

Folder Organization

Folder Structure

Organize your requirements using nested folder structures

Specification Views

  • Table View: See all requirements in tabular format
  • Tree View: Visualize hierarchical structure
  • Custom Views: Save filtered views for specific use cases
  • Comparison View: Compare requirements across different baselines

Custom Views Example

Custom Views

Create and save custom views to filter and organize requirements

Traceability Matrix

Create comprehensive traceability between different requirement levels to track relationships and ensure complete coverage.

Setting Up Traceability

  1. Create Traceability Matrix:
    • Navigate to Traceability section
    • Click "Create New Traceability"
    • Define traceability levels (e.g., Business Requirements → Functional Requirements)
  2. Configure Levels:
    • Source Level: Starting requirement type
    • Target Level: Destination requirement type
    • Link Types: Define relationship types between levels

Coverage Analysis

Analyze requirement coverage to identify gaps and ensure comprehensive testing and implementation.

Creating Coverage Matrices

  1. Setup Coverage View:
    • Navigate to Coverage section
    • Click "Create Coverage"
    • Define matrix dimensions (rows and columns)
  2. Configure Matrix:
    • Rows: Select source requirement type
    • Columns: Select target type
    • Link Types: Specify which Jira link types to consider

Review System

Implement collaborative review processes to ensure requirement quality and stakeholder alignment.

Review Interface

Review System Interface

Collaborative review interface for requirement validation

Creating Reviews

  1. Initiate Review:
    • Select requirements for review
    • Click "Create Review"
    • Add reviewers and set deadlines
  2. Review Configuration:
    • Review Type: Formal or informal review process
    • Participants: Add reviewers with different roles
    • Review Fields: Configure what aspects to review

Best Practices

Requirements Organization

  • Consistent Hierarchy: Maintain consistent requirement levels across projects
  • Clear Naming: Use descriptive and consistent naming conventions
  • Appropriate Granularity: Break down requirements to appropriate detail levels
  • Version Control: Use baselines to track requirement evolution

Traceability Management

  • Complete Traces: Ensure all requirements have appropriate traces
  • Bidirectional Links: Maintain links in both directions
  • Regular Updates: Keep traceability current with requirement changes
  • Gap Monitoring: Regularly check for traceability gaps

Need Help?

For additional support or questions about NewSysRS: