Comprehensive Guide to Creating, Reviewing, and Updating Requirements
Customer Guide
Table of Contents
Overview
This guide provides a comprehensive overview of creating, reviewing, and updating project requirements. You'll learn how to initiate a requirement and what steps to follow when it's ready for approval. Upon creation and reaching the status of "Waiting for Approval," you will receive an email notification prompting you for approval. This email contains a "View the Request" link, directing you to the requirement on the Eccovia Help Center / Requirement Scoping Portal.
Steps for Creating, Reviewing and Updating Requirements
Login and Settings
Accessing the Portal: Start by accessing the email notification related to the requirement. If you haven’t logged in before, you'll be prompted to create a logon.
Profile, Settings, and Customization
- In the upper right-hand corner, you will see your logon circle with a numeric value. Click on it to access your profile settings.
- The portal is accessible from phones, tablets, and computers, providing flexibility in how you access your requirements.
Portal Customization
- The portal allows you to customize your view, update settings, and filter specific values. These options are available through your profile or within the view settings.
-
Manage Columns: In the portal, use the "Manage Columns" option to add additional fields, such as:
- Created
- Updated
- Assignee
- Due Date
- Priority
Your Project Manager's Role
Your project manager will set up the requirement with the following:
- Add Approver(s): Approvers, who are responsible for the final review, will be added based on your process. This grants them access to approve the requirement.
- Add Participant(s): Participants will be added to allow them to view the requirements in the portal.
- Contract ID: The contract ID will be linked to all related requirements.
- Requirement Status: The phase of the requirement
- Due Date: The Due Date reflects the agreed time to have the requirements reviewed.
Your Contributions to the Requirement Process
Your team will provide further details to ensure the requirements meet your solution needs by supplying the following:
Requirement Field | Definition |
Contract ID | Uniquely identify the contract section associated with the requirement, ensuring traceability and reference. |
Summary | Provides a brief overview of the requirement to quickly convey its essential purpose and scope. The naming format is critical to traceability. |
Description | Offers a detailed explanation of the requirement, including specific needs, objectives, and context. |
Story | Describes the user story or scenario that the requirement addresses, focusing on user needs and experiences. |
Acceptance Criteria | Defines the conditions that must be met for the requirement to be considered complete and acceptable. |
Navigation Path | Specifies the steps, workgroup, or sequence needed to access or implement the requirement within the user interface |
Business Rules | Enumerates the constraints and guidelines that govern the requirement, ensuring alignment with organizational policies. |
Demonstration | Used to identify builds that are ready for review and assessment, demonstrating the requirement in action. |
Approvers | Specifies the project manager responsible for approving newly created requirements, ensuring proper authorization and accountability. It will also reflect your teams’ approvers. |
Accessing the Portal
-
Upon receiving the email notification, click the View the Request link. This will take you directly to the Requirement Scoping Portal.
- If you're not logged in, you'll need to create or enter your credentials.
Creating a Requirement
You can create requirements from the portal that will not be linked to the project’s Jira system. When adding requirements before the build phase, it's essential to add your project manager as the approver.
Generating Requirements from the Portal
You can access the portal requirement creation by the following:
- Navigate to the portal from your previous emails and select Eccovia Help Center.
- Select Requirements.
- After clicking the 'Requirements' hyperlink, the requirements form will appear. Complete the form thoroughly to aid in the successful build process.
Navigating the Portal
-
Viewing Requirement
-
There are multiple ways to access the requirement details:
- Click the reference number provided by your project manager.
- Click the requirement directly from the email notification.
- Navigate to your Requirement Portal.
-
There are multiple ways to access the requirement details:
- Search Functionality: Use the Search feature to locate specific requirements.
-
Filter Functionality: You can filter your view to see all requirements or only those awaiting your approval:
- Filter by Status.
- Filter using the ALL dropdown, which allows you to see options like Created by Me and Where I am a Participant.
Reviewing Requirement Content
-
Show Details
- Once inside the requirement, click Show Details to see all relevant information, such as the contract ID, user stories, business rules, discovery questions, navigation path, approvers, and priority levels.
-
Comments and Upload Attachments
- Scroll down to add comments, which will be reflected in the Eccovia Jira system.
- You can upload attachments and screenshots in the comments section.
Updating Requirements
-
Update the requirement status by selecting one of the following options:
- Approve
- Decline
- Change in Requirement: The project manager will update the requirement to "Change in Requirements" to ensure the requirements are always current.
- Requirement Updates: Updates to the requirements will generate an email notification.
Note: Once a requirement is approved, any further changes will require a formal change request. |
Quality Assurance (QA) Process
- After approval, the project’s Quality Assurance Engineer will be assigned to the requirement to create test cases and conduct QA testing.
- The results of the testing can be provided in Excel or PDF format.
Additional Considerations
-
Requirement Visibility
- Besides the portal, your project manager can provide an Excel export of the requirements or share them through collaborative tools like Smartsheet.
This guide is intended to help you efficiently navigate the requirement approval process. For further assistance, please contact your project manager.
Contributing Guides
- Video Recordings and Documentation: Implementation Services Training
-
Requirement Status Lifecycle - Eccovia
- Link to the Test Case Generation Process