pacifique-sops System Requirements Document

Introduction

The purpose of the pacifique-sops project is to develop an internal company website for employees of Pacifique Investments. This platform will serve as a centralized repository for Standard Operating Procedures (SOPs), providing employees with access to critical operational guidelines while ensuring secure and efficient management of these documents.

System Overview

The pacifique-sops system is designed to facilitate the management and dissemination of SOPs within Pacifique Investments. It will feature access controls based on departmental roles, allow users to flag SOPs for review, and provide analytics on SOP status and activity. The system will integrate with Google authentication, ensuring secure access limited to company email addresses. The platform will be built using the MERN stack to ensure scalability and ease of deployment.

Functional Requirements

• As an Employee, I should be able to access SOPs relevant to my department (HR, Sales, Operations, B2B, Admin).
• As an Employee, I should be able to flag SOPs that need to be reviewed, including adding a category and comments.
• As an Admin, I should be able to assign periodic review frequencies to each SOP.
• As an Employee, I should be able to view a holistic dashboard showing the number of SOPs by department, year added, those needing updates, upcoming reviews, newly added SOPs, and SOPs under construction.
• As an Employee, I should be able to print SOPs with a company header and footer.
• As an Admin, I should be able to track all activities of each employee, including viewing, downloading, printing, and suggesting edits.
• As an Employee, I should be able to authenticate using my company email via Google authentication.

User Personas

• Employee: A general user who accesses SOPs relevant to their department and interacts with the system to flag SOPs for review and track updates.
• Admin: A user with elevated privileges who manages SOP review schedules, monitors user activities, and oversees the overall SOP management process.

Core User Flows

• Employee logs in using Google authentication -> accesses department-specific SOPs -> flags an SOP for review -> adds comments -> views dashboard for SOP status.
• Admin logs in -> assigns review frequencies to SOPs -> monitors employee activities -> updates SOPs as needed -> generates reports on SOP status.

Visuals Colors and Theme

• primary: #2A9D8F (Teal)
• primary_light: #A8DADC (Light Teal)
• secondary: #E76F51 (Coral)
• accent: #F4A261 (Sandy Orange)
• highlight: #E9C46A (Golden Yellow)
• bg: #F1FAEE (Off White)
• surface: rgba(42, 157, 143, 0.8)
• text: #264653 (Dark Slate)
• text_muted: #8D99AE (Muted Gray)
• border: rgba(233, 69, 96, 0.2)

Signature Design Concept

The homepage of pacifique-sops will feature an interactive "SOP Universe" concept. Using @react-three/fiber and @react-three/drei, the homepage will display a 3D galaxy where each star represents a department. Clicking on a star zooms into a constellation of SOPs, each represented as a planet. Users can rotate and explore the galaxy, with hover interactions highlighting SOPs needing review. This dynamic and engaging interface will make navigating SOPs an intuitive and visually appealing experience.

Interaction Model & Motion Direction

The landing page will employ a "parallax" interaction model, creating a layered depth effect as users scroll through the SOP Universe. Decorative elements will move at varying speeds, enhancing the immersive experience. Internal pages will maintain a "static" interaction model to prioritize clarity and ease of use for SOP management tasks.

Non-Functional Requirements

• The system must ensure secure access control using Google authentication limited to company email addresses.
• The platform should be scalable to accommodate future growth in SOPs and user base.
• The system should be intuitive and user-friendly, with a modern and minimal design.

Tech Stack

• Frontend: React
• Backend: Node.js, Express
• Database: MongoDB
• Authentication: Google OAuth
• Deployment: Docker, Kubernetes

Assumptions and Constraints

• The system will be used internally within Pacifique Investments and will not require external access.
• All users will have a company email address for authentication.
• The platform will be developed using the MERN stack for consistency and ease of integration.

Glossary

• SOP: Standard Operating Procedure
• MERN: MongoDB, Express, React, Node.js
• OAuth: Open Authorization, a standard for token-based authentication