International Portal Business Requirements & Software Requirements Specification

From UG

Contents 1 Mantis 2 Project Overview 2.1 Business Objectives 2.2 High Level Deliverables 2.3 Project Stakeholders & Roles 2.4 Project Scope 2.4.1 Out-Of-Scope 2.5 Project Dependencies 2.6 High-Level Timelines 2.7 Risks 3 Assumptions / Constraints 4 Business Requirements 4.1 Business Requirement 1... 4.2 Business Requirement 2... 4.3 Business Requirement 3... 4.4 Business Process Flow 1... 4.5 Business Process Flow 2... 4.6 Business Process Flow 3... 5 Functional/Non-Functional Requirements 5.1 CyberTrax2 Internal Application 5.1.1 User Interface Requirements 5.1.2 Reporting Requirements 5.1.3 User Access / Security Requirements 5.1.4 Logging Requirements 5.1.5 Group / Master Requirements 5.1.6 Filtering Requirements 5.1.7 Archiving Requirements 5.2 CyberTrax2 Client Application 5.2.1 User Interface Requirements 5.2.2 Reporting Requirements 5.2.3 User Access / Security Requirements 5.2.4 Logging Requirements 5.2.5 Group / Master Requirements 5.2.6 Filtering Requirements 5.2.7 Archiving Requirements 5.3 Non-Functional Requirements 5.3.1 Performance Requirements 5.3.2 Capacity Requirements 5.3.3 Support / Maintenance Requirements 5.3.3.1 User Guides 5.3.3.2 Training 5.3.3.3 Log(s) Accessibility 5.3.4 Testing Requirements 5.3.5 Security Requirements 6 Technical Design & Solution 6.1 Mock ups 6.2 Technology Stack & Architecture 6.3 Technical Diagrams (Flow Chart, Sequence, UML, Systems Architecture, Technical Architecture, Data Architecture, etc..) 6.4 Web / Application (New/Modified classes, methods, etc..) 6.5 Database (DDL changes - new/modified tables, indexes, stored procedures, etc..) 6.6 Configuration (Config File changes) 6.7 Logging (Log File changes) 6.8 External Interfaces (EDI Message(s), external vendors)

[edit] Mantis

<Mantis Number(s) & Link>

[edit] Project Overview

<Executive summary of business justification(s), business objective(s), high level project deliverables, project vision, all stakeholders, etc..>

[edit] Business Objectives

The primary objective of International Portal (I-Portal) is to create a platform for CyberTrax2 to transform into Software-As-A-Service (SaaS) system that Jaguar Freight Services can offer as a fee-based service to external clients. Clients would be able to manage all aspects of their shipments from within CyberTrax2 for both domestic and international shipments. The portal should provide client users with the ability to create shipments, approve shipments, track shipments, etc..

The portal must be web accessible, secure, user-friendly, flexible, and scalable. The portal must also take into account data visibility rules (Clients will only be able to edit/view their own data) and system performance.

[edit] High Level Deliverables

• Flexible Entitlements Management System
• User Interface Templates
• Client Specific Reporting
• Optimize current CT2 Client performance

[edit] Project Stakeholders & Roles

• Simon Kaye - CEO - Project Sponsor
• Marc Selter - VP - Product Manager
• Alex Dobrovolsky - Director of Technology - Solutions Architect
• Montira Renfrew - CT2 Systems Analyst
• Alex Pivniak - CT2 Software Developer (Elcosol)
• Denise Guastella - CT2 Support Manager
• Kostiantyn Ushakov - CEO/CTO Elcosol
• Perry Lee - CT2 Project Manager

[edit] Project Scope

<Identify in-scope and out-of-scope items>

[edit] Out-Of-Scope

• SAS 70 & ISO27001 Compliance
• Web Application Penetration Tests
• High Availability (HA) Disaster Recovery environment(s)
• 100% integration of both Internal CT2 & Client CT2
• Functional & Non-Functional gaps in Internal CT2

[edit] Project Dependencies

<Identify internal and external dependencies to the project>

[edit] High-Level Timelines

<High-level milestone dates>

[edit] Risks

<Identify internal and external risks to the project: schedule, resources, technical, business, cost, market conditions, external vendors/partners, etc..>

[edit] Assumptions / Constraints

<Identify all assumptions and constraints for this project>

[edit] Business Requirements

<List each business requirement under a separate heading. Also include process flows (UML, Sequence Diagrams, Swimlane, Flow chart, etc..) as applicable>

[edit] Business Requirement 1...

[edit] Business Requirement 2...

[edit] Business Requirement 3...

[edit] Business Process Flow 1...

[edit] Business Process Flow 2...

[edit] Business Process Flow 3...

[edit] Functional/Non-Functional Requirements

<Identify all functional and non-functional requirements. Maintain standard headings. If a specific requirement is not required, note as Not Applicable. Each functional requirement must trace back to a specific business requirement.>

[edit] CyberTrax2 Internal Application

<Identify all functional requirements for CT2 Internal Application>

[edit] User Interface Requirements

[edit] Reporting Requirements

[edit] User Access / Security Requirements

[edit] Logging Requirements

[edit] Group / Master Requirements

[edit] Filtering Requirements

[edit] Archiving Requirements

[edit] CyberTrax2 Client Application

<Identify all functional requirements for CT2 Client Application>

[edit] User Interface Requirements

[edit] Reporting Requirements

[edit] User Access / Security Requirements

[edit] Logging Requirements

[edit] Group / Master Requirements

[edit] Filtering Requirements

[edit] Archiving Requirements

[edit] Non-Functional Requirements

<Identify all non-functional requirements for both CT2 Client Application and CT2 Internal Application>

[edit] Performance Requirements

[edit] Capacity Requirements

[edit] Support / Maintenance Requirements

[edit] User Guides

[edit] Training

[edit] Log(s) Accessibility

[edit] Testing Requirements

[edit] Security Requirements

[edit] Technical Design & Solution

[edit] Mock ups

<Include mock-ups of UI changes, report changes, etc..>

[edit] Technology Stack & Architecture

<Include changes to existing Technology Stack & Architecture - new libraries, updated library versions, new software/hardware, new interfaces, etc..>

[edit] Technical Diagrams (Flow Chart, Sequence, UML, Systems Architecture, Technical Architecture, Data Architecture, etc..)

<Include architecture diagrams and flow charts>

[edit] Web / Application (New/Modified classes, methods, etc..)

<List new or modified classes and methods>

[edit] Database (DDL changes - new/modified tables, indexes, stored procedures, etc..)

<Summarize database changes>

[edit] Configuration (Config File changes)

<Summarize config changes>

[edit] Logging (Log File changes)

<Summarize Log File changes and locations>

[edit] External Interfaces (EDI Message(s), external vendors)

<Identify any new external interfaces. Include sample request and reply along with field definitions. Include Source/Target server(s)/webservice(s) and functional accounts. If this is a modification of an existing EDI message, include samples of current message(s) and new message(s)>