copper-vas

byO'brien Mak

vas y

No preview

Comments (0)

No comments yet. Be the first!

System Requirements

System Requirement Document
Page 1 of 6

System Requirements Document

1. Introduction

Zeno is a modern SaaS platform designed for schools, initially targeting the Democratic Republic of Congo (DRC). The platform aims to centralize daily school operations into a simple interface, allowing school directors to configure their schools and teams while automating information flow. The focus is on providing a premium, modern, and reliable user experience inspired by the best practices of Apple, Google, and OpenAI.

2. System Overview

Zeno is designed to manage the complexity of school operations without requiring technical expertise from the director. The platform supports multiple roles, including Director, Secretary, Accountant, and Teacher, each with specific access to relevant information. The system is built to handle multiple teachers, secretaries, accountants, classes, and thousands of students, with a focus on simplicity and ease of use.

3. Functional Requirements

Page 2 of 6

As a Director:

  • I want to configure the school progressively, including the school name, academic year, classes, subjects, staff, and administrative rules.
  • I want to create and manage staff accounts, assign responsibilities, and define custom roles.
  • I want to have a global view of the school, including student numbers, daily attendance, teacher presence, incomplete files, and financial status.
  • I want to be able to search for students, teachers, classes, and invoices based on my permissions.
  • I want to publish announcements and notifications targeted by role, class, or group.
  • I want to view audit logs for sensitive actions like role changes and financial transactions.

As a Secretary:

  • I want to register new students with necessary information and manage student records.
  • I want to import student data from Excel/CSV files with error detection and preview.
  • I want to manage administrative communications and incomplete files efficiently.

As an Accountant:

  • I want to manage school fees, invoices, payments, partial payments, balances, and financial reports.
  • I want each invoice to have a unique identifier and link payments reliably to invoices and students.

As a Teacher:

  • I want to see only the information relevant to my work, such as my classes, subjects, students, schedule, attendance, grades, and assignments.
  • I want to take attendance quickly, marking only absent or late students, with automatic recording of attendance data.
  • I want to receive reminders for attendance and other tasks based on my schedule.
  • I want to manage and record student grades (notes) efficiently.
  • I want to assign and track homework (devoirs) for my students.
  • I want access to useful information (informations utiles) related to my classes and subjects.
Page 3 of 6

As a System:

  • I want to support role-based permissions and data isolation between schools.
  • I want to provide a global search feature that returns results based on user permissions.
  • I want to handle Mobile Money payments with a reliable architecture for future integration.
  • I want to maintain audit logs that cannot be modified by users.

4. User Personas

  • Director: Configures the school, manages staff and roles, and oversees school operations.
  • Secretary: Manages student records, imports data, and handles administrative tasks.
  • Accountant: Manages financial operations, including fees, invoices, and payments.
  • Teacher: Manages class-related tasks, including attendance, grading, and assignments.

5. Core User Flows

Director's Flow:

  1. Log in to the platform.
  2. Configure school settings and staff roles.
  3. Monitor school operations via the dashboard.
  4. Publish announcements and manage communications.

Secretary's Flow:

  1. Log in to the platform.
  2. Register new students and manage records.
  3. Import student data from Excel/CSV.
  4. Handle administrative communications.
Page 4 of 6

Accountant's Flow:

  1. Log in to the platform.
  2. Manage invoices and payments.
  3. Generate financial reports.

Teacher's Flow:

  1. Log in to the platform.
  2. View schedule and class information.
  3. Take attendance and manage grades.
  4. Assign and track homework.
  5. Access useful class-related information.

6. Visuals Colors and Theme

The design should be premium, calm, clear, modern, and responsive, with inspiration from Apple, Google, and OpenAI. Avoid overloaded dashboards and excessive decorative elements.

7. Signature Design Concept

The design should prioritize user experience, with a focus on simplicity and clarity. Animations should be discreet and functional, enhancing user interactions without being distracting.

8. Interaction Model & Motion Direction

The interaction model should be intuitive, with short transitions, natural notifications, and smooth page changes. Feedback should be provided for user actions, and loading states should be clearly indicated.

Page 5 of 6

9. Non-Functional Requirements

  • The system must be secure, with role-based permissions and data protection.
  • It must be scalable to handle multiple schools and thousands of students.
  • The platform should be mobile-first and responsive.

10. Tech Stack

  • Next.js
  • TypeScript
  • Supabase
  • PostgreSQL
  • Tailwind CSS
  • shadcn/ui
  • React Hook Form
  • Zod
  • Recharts
  • PWA

11. Assumptions and Constraints

  • The initial version excludes parent and student accounts.
  • The platform must support future integration with Mobile Money providers.
  • The system should be developed with a minimal initial budget, using tools like Replit for prototyping.
Page 6 of 6

12. Glossary

  • SaaS: Software as a Service
  • RDC: Democratic Republic of Congo
  • CRUD: Create, Read, Update, Delete
  • ERP: Enterprise Resource Planning
  • PWA: Progressive Web App

No completed page designs yet.

Completed design pages will appear here when they are ready to preview.

Login: Log in
Invoices & Payments: Manage invoices
Invoices & Payments: Record payments
Financial Reports: Generate financial report

No completed page designs yet.

Completed design pages will appear here when they are ready to preview.

Login: Log in
Invoices & Payments: Manage invoices
Invoices & Payments: Record payments
Financial Reports: Generate financial report