Skip to content

Contributor's doc

Jump to bottom
Peculiar C. Umeh edited this page Mar 29, 2023 · 9 revisions

Mentors Management System - Product Brief

Mentors Management System(MMS) is a people management app that enables proper coordination of mentors needed to execute projects, ranging from recruitment to offboarding.

Required Features

Each application should have the following features:

  • Authentication/Authorization
  • Recruitment
  • Communication and Engagement
  • Program Scheduling
  • Activities Tracking and Reporting
  • Discussion Forum

User Requirements

There are three categories of users - Admin, Mentor Manager(MM), and Mentor.

Admin Category:

As an Admin user, I must be able to:

  • Login/Logout
  • Create program
  • Add MM
  • Add mentor
  • Label/unlabeled MM
  • Label/unlabeled mentors
  • See the list of all MM
  • See the list of all mentors
  • Browse MM details
  • Browse the mentor’s details
  • Search by name, category, region, program, engagement status
  • Assign/unassign MM to the program
  • Assign/unassign a mentor to the program
  • Archive a program
  • Delete a program
  • Generate program report at an interval
  • Download the program report
  • Share program report via email
  • Generate MM report
  • Delete MM
  • Delete mentor
  • Receive notifications from MM activities
  • Generate MM certificate
  • Generate mentor certificate
  • Approve mentor certificate generated and shared by MM
  • Send broadcast message to all MM
  • Send broadcast message to all mentors
  • Chat 1:1 with any user
  • See the list of mentors’ applicants
  • Set up criteria for selection
  • Generate the list of selected mentors
  • Message the list of chosen mentors
  • Generate the list of unselected mentors
  • Message the list of unselected mentors
  • Engage in the discussion forum

Mentor Manager Category:

As a MM user, I must be able to:

  • Login/Logout
  • Set up my profile
  • Access assigned programs
  • Add a mentor to the system
  • See the list of all mentors
  • Browse the mentor’s details
  • Search mentors by name, category, region, program, engagement status
  • Assign/unassign a mentor to the program
  • Generate mentors’ report
  • Share the report
  • Delete mentor
  • Receive notifications from mentor activities
  • Generate mentor certificate
  • Share the certificate with Admin
  • Send approval request for mentor certificate
  • Send broadcast message to all MM
  • Send broadcast message to all mentors
  • Chat 1:1 with any user
  • Engage in the discussion forum

Mentor Category:

  • As a mentor user, I must be able to:
  • Apply to be a mentor
  • Receive application status message
  • Login/Logout
  • Set up my profile
  • Access assigned programs
  • Access the list of assigned tasks
  • Apply to be assigned to a program/tasks
  • Engage in the discussion forum
  • Browse the given MMS details
  • Compose updates on your assigned tasks
  • Share tasks updates with your assigned MM
  • Receive notification from task’s assignment
  • Apply for a mentor certificate
  • Receive a notification to download or not qualify for the certificate
  • Chat 1:1 with any user

User category details

Admin Andela's staff, mainly the Program Manager, oversees the end-to-end execution of a learning program. In addition, he coordinates all resources to ensure the program is delivered to meet the set-out goal. Allow signing into the system through Andela's email account only. He has a job title.

Mentor Manager Program Assistants assist the program managers in the execution of a learning program. They oversee the activities of mentors and interact directly with them. They are volunteers and need to access the system via their email accounts.

Mentor Mentors are volunteers who interact directly with the learners with the sole responsibility of unblocking them and encouraging them to meet learning goals. Usually, we have a mentor to a group of 10 -20 learners.

Contributors Guidelines

You should take these steps so you can start contributing to the project.

  1. Go through the README.
  2. Go through the Issue Tracker Board for your project.
    image
  3. Select an issue (Ensure your mentors assigns it to you), then move the issue to the Issue Tracker Board.
  4. Check here on how to clone the repository
  5. Create your branch from develop branch (Ref. README). How to create a branch
  6. Code and submit a PR.
  7. Move the issue to the Issue Tracker Board, e.g., Todo, In-progress and Done.

Project Deliverables: (10 weeks)

  • 1st Sprint (2 weeks): ADMIN - AUTH | DASHBOARD | PROFILE | SETTINGS

  • 2nd Sprint (2 weeks): 1. ADMIN - MESSAGES | CHATS | DISCUSSION FORUM 2. ADMIN - REPORTS | TASKS

  • 3rd Sprint (2 weeks): 1. ADMIN - MENTORS 2, ADMIN - MENTOR MANAGERS

  • 4th Sprint (2 weeks): ADMIN - PROGRAMS | CRITERIA SETUP

  • 5th Sprint (2 weeks): 1. ADMIN - APPROVAL REQUESTS 2. ADMIN - NOTIFICATION | SEARCH 3. ADMIN - CERTIFICATES

Clone this wiki locally