NFRS Asset Management System - Functional Specification

⌘K
  2. Home
  4. Docs
  6. NFRS Asset Management Sys...
  8. Project Overview
  10. Overview

Overview

1. Project Overview 

1.1 Project Brief 

  • Project Name: NFRS Asset Management System 
  • Project Manager: Ian Hudson 
  • Date: 24 Jul 2023 
  • Version: v 1.0 

1.2 Project Rationale 

  • Purpose: Describe the purpose of the project, such as improving efficiency, automating processes, or enhancing user experience. 
  • Objectives: List the key objectives of the project, such as reducing manual effort, providing real-time data access, or improving collaboration. 
  • Benefits: Explain the expected benefits of the project, such as time savings, cost reduction, or increased accuracy. 

2. User Requirements 

2.1 User Stories 

  • User Story 1: As a [user role], I want [feature] so that [benefit]. 
  • User Story 2: As a [user role], I need [feature] to [benefit]. 
  • Additional User Stories: Add more user stories as needed. 

2.2 User Roles and Responsibilities 

  • Role 1: [Role description, e.g., “Administrator – manages user access and system configurations.”] 
  • Role 2: [Role description, e.g., “User – interacts with the app to complete daily tasks.”] 

2.3 Use Cases 

  • Use Case 1: Describe the use case, including the steps involved, actors, and expected outcomes. 
  • Use Case 2: Describe the use case, including the steps involved, actors, and expected outcomes. 

3. Functional Requirements 

3.1 Features 

  • Feature 1: Description of the feature, its purpose, and how it will be used. 
  • Feature 2: Description of the feature, its purpose, and how it will be used. 

3.2 Power Platform Components 

  • Power App:
    • Description: [Enter description of the app’s purpose and functionality] 
    • Screens: [List the screens and their purposes, e.g., “Home Screen – displays dashboard,” “Detail Screen – shows item details”] 
    • User Interactions: [Describe user interactions, e.g., “Users can filter data by date.”] 
  • Model-Driven App:
    • Description: [Enter description] 
    • Entities: [List entities, e.g., “Customer,” “Order”] 
    • Relationships: [Describe table relationships, e.g., “Each order is linked to a customer”] 
  • Power Automate:
    • Flow 1: [Enter flow name and description, e.g., “Approval Flow – automates document approval process”] 
    • Flow 2: [Enter flow name and description, e.g., “Notification Flow – sends email notifications on updates”] 

3.3 SharePoint Integration 

  • SharePoint Lists:
    • List 1: [List name and description, e.g., “Project Tasks – tracks project tasks and statuses”] 
    • List 2: [List name and description, e.g., “Employee Directory – stores employee contact information”] 
  • Document Library:
    • Library Name: [Enter library name, e.g., “Project Documents”] 
    • Documents: [Describe types of documents stored, e.g., “Proposals, reports, and meeting minutes”] 
  • Team Site:
    • Site Name: [Enter site name, e.g., “Project Collaboration Site”] 
    • Sections: [Describe sections of the site, e.g., “Announcements, Document Library, Task List”] 

4. Technical Specifications 

4.1 Architecture 

  • Architecture Diagram: [Include or link to an architecture diagram] 
  • Components: Describe each component of the architecture, such as databases, services, and interfaces. 

4.2 Data Model 

  • Entities: List and describe entities, e.g., “Customer – stores customer details,” “Order – stores order information.” 
  • Relationships: Describe relationships between entities, e.g., “One customer can have multiple orders.” 

4.3 Security 

  • User Authentication: Describe how users will be authenticated, e.g., “Single Sign-On (SSO) with Azure AD.” 
  • Data Access: Describe data access controls, e.g., “Role-based access control (RBAC) to ensure only authorized users can access sensitive data.” 

5. Design 

5.1 User Interface Design 

  • Wireframes: Include wireframes or mockups of the UI. 
  • User Experience: Describe the intended user experience, focusing on usability and accessibility. 

5.2 Branding and Theming 

  • Colors: List colors to be used, e.g., “Primary Color: #0078D4, Secondary Color: #FFFFFF.” 
  • Fonts: List fonts to be used, e.g., “Primary Font: Segoe UI, Secondary Font: Arial.” 

6. Implementation Plan 

6.1 Development Timeline 

  • Phase 1: [Description of phase 1, e.g., “Requirements gathering and initial design.”] 
  • Phase 2: [Description of phase 2, e.g., “Development and testing.”] 

6.2 Testing 

  • Testing Plan: Describe the testing plan, including types of testing (e.g., unit testing, integration testing) and testing stages. 
  • Test Cases: List test cases, e.g., “Test Case 1: User login functionality,” “Test Case 2: Data validation.” 

7. Documentation 

7.1 User Guide 

  • Getting Started: [Instructions for getting started, e.g., “How to access the Power App.”] 
  • Using the App: [Instructions for using the app, e.g., “How to create a new record.”] 

7.2 Technical Documentation 

  • APIs: Describe any APIs used, including endpoints and data formats. 
  • Configurations: Describe any configurations needed, e.g., “Configuring environment variables.” 

8. Maintenance and Support 

8.1 Support Plan 

  • Support Contacts: List support contacts, e.g., “Support Email: support@example.com.” 
  • Issue Tracking: Describe the issue tracking process, e.g., “Using Jira for bug tracking.” 

8.2 Maintenance Schedule 

  • Regular Maintenance: Describe regular maintenance tasks, e.g., “Weekly data backups.” 
  • Updates: Describe how updates will be handled, e.g., “Monthly feature updates.” 

9. Appendices 

9.1 Glossary 

  • Term 1: [Definition, e.g., “Entity – A data object in the system.”] 
  • Term 2: [Definition, e.g., “Flow – An automated process in Power Automate.”] 

9.2 References 

How can we help?