Initiate the documentation for scholarX

Hi guys! In the last dev team stand-ups, I was assigned to initiate the documentation for scholarX on the GitHub docs. I have a problem with the content. Is there any stuff that we currently have or do we have to start from scratch? @EngTeam

I decided to make a sketch of the content as the first stage in ScholarX documentation, therefore I separated the documentation into two parts.

  1. Create a New Program
  2. Manage The Program

Create a New Program -
In this section, I planned to guide the user through the necessary procedures for creating a new program in the scholarX platform, as well as the necessary images.

Manage The Program -
In this section, there are nine primary sections that are the same as in the application.

  • Phase 1 - Created
  • Phase 2 - Mentor Application Period
  • Phase 3 - Mentor approval period
  • Phase 4 - Mentee Application Period
  • Phase 5 - Admin-Mentee Filtration Period
  • Phase 6 - Mentee Approval Period
  • Phase 7 - Wildcard period
  • Phase 8 - Ongoing
  • Phase 9 - Completed

So my objective is to go over each process and write down a detailed guide for each one, along with images.

WDYT? @Gravewalker @anjisvj @jaye. Is there anything further to add to the above-mentioned topics?

I created the content structure for the documentation on the scholarX wiki

3 Likes

This looks good, Gajindu!

I began documenting under the first key topic listed in the plan above. The “Create a New Program” section was completed. https://github.com/sef-global/scholarx/wiki/ScholarX-Documentation

WDYT?? @jaye @anjisvj @Gravewalker

1 Like

Awesome! Good job, Gajindu! :clap:

Feel free to divide them into new pages if things get longer.

Later, we might need to expand this documentation for the mentors and mentees. ex: how to apply, how to manage mentees, etc.
Assign some work to @kumuditha_udayanga if he is available this week.

It would be nice if you could provide us with a rough timeline of relevant tasks. So that it would be easy for us to get an overview.

Thanks! Good work as always! :clap: :clap: :hugs:

1 Like

This is nice! And I have a small suggestion.
Let’s add sections for the Users and Program states.

In the Users section, we can add the following details.

  • Main user types in the system
    • admin
    • default
      • selected mentor
      • selected mentee
  • What each user can do (maybe a small description)

In the program states section, we can add these details:

  • List of program states
  • What is done under each state(phase)
1 Like

Hello everyone! We had a conversation regarding the scholarX documentation during the recent stand-up. The initial goal was to finish the content, so I contacted @kumuditha_udayanga and we worked together to create the content for this documentation. I’ll attach the documentation content that we generated.

We created material for the application’s nine phases, dividing it into the primary three roles and explaining the stuff for each. This is not the finalized structure; it is just the content. Could you please check this content and provide feedback?

Phase 1 - Created

Phase summary - The program is in the created state.

  • Admin - Not Applicable
  • Mentor- Not Applicable
  • Mentee - Not Applicable

Phase 2 - Mentor Application Period

Phase summary - In this state, mentors can start sending their applications.

  • Admin - Not Applicable
  • Mentor -
    • The mentor can click the “Apply as mentor” button to apply for a program.
    • [Image]
    • Once clicked the mentor application will be displayed
    • [Image]
    • In the form, there are six fields that should be filled
      • Category - Select the Field of Study from the dropdown menu.
      • Expertise - Expert skill or knowledge in a particular field
      • Institution - Place of work
      • Current Position - occupation
      • Bio - A small description of the mentor
      • Number of Mentee Slots - Number of mentees that the mentor can select
    • Once filled mentor can select click on “Submit” to submit the application.
  • Mentee - Not Applicable

Phase 3 - Mentor approval period

Phase summary - During this state, the admin can review the mentor application and approve or reject them.

  • Admin -
    • Admin has to select the mentors from the mentor application pool
    • First, the admin has to click the “Manage” button of the application.
      [Image]
    • Next, go to the “Manage mentors” to select the mentors for the application.
      [Image]
    • All the applied mentors will be displayed in the user interface
      [Image]
    • Admin can approve, reject or remove the applied mentors by clicking the respective buttons
    • After clicking the button as mentioned above the state of the mentor will change from pending to the selected option
      [Image]
  • Mentor - Not Applicable
  • Mentee - Not Applicable

Phase 4 - Mentee Application Period

Phase summary -In this state, mentees can start sending their applications.

  • Admin - Not Applicable
  • Mentor - Not Applicable
  • Mentee -
    • Click the “Apply as mentee” to apply to a respective program
      [Image]
    • On this page, all the mentors will be displayed in the UI
      [Image]
    • Mentees can view the meteor details by clicking on the mentor names
      [Image]
    • Click the “Apply” button to apply as a mentee
      [Image]
    • Next, fill out the below fields to apply as a mentee
      • Primary Mentor
      • University
      • Course/Major
      • Year of study
      • Future Ambitions and Intentions (Minimum 1500 characters)
      • Reason for choosing this mentor (Minimum 1500 characters)
      • Summary of your achievements
      • Resume URL (Drive link or a personal website link)
    • After filling all the fields mentee can click the “Apply” button.

Phase 5 - Admin-Mentee Filtration Period

Phase summary -During this state, the admin can review the mentee applications and assign them to mentors for further review.

  • Admin -
    • The admins can filter the applications of the mentees in the phrase.
    • Admin can access the manage mentees feature, which displays a list of all mentees.
      [image]
    • Admins will inspect each application and remove the incompleted applications from here.
  • Mentor- Not Applicable
  • Mentee - Not Applicable

Phase 6 - Mentee Approval Period

Phase summary -During this state, mentors can review the mentor application and approve or reject them.

  • Admin- Not Applicable
  • Mentor -
    • The mentor can click on the “Manage” button to manage the applied mentees.
    • A mentor can either “Approve” or “Reject” the mentees.
    • The approved and rejected mentees will be clearly displayed in a list as below.
      [Image]
    • Mentor can view the details of each and every mentee by clicking the mentees name
      [Image]
    • A mentor can leave a comment to the mentee
      [Image]
  • Mentee - Not Applicable

Phase 7 - Wildcard period

Phase summary -During this state, the admin can assign mentors for the mentees who are not approved by mentors.

  • Admin - In the admin’s “manage mentees” section admin can assign the mentors for the mentees or reject them as in the below Image.
    [Image]
  • Mentor- Not Applicable
  • Mentee - Not Applicable

Phase 8 - Ongoing

Phase summary -This state indicates that the program is currently running.

Phase 9 - Completed

Phase summary -The program is completed.

1 Like

This is great! Thank you @Gajindu_Bandara and @kumuditha_udayanga! Let’s put this on the wiki and finish this. @jaye Are we missing something here?

I added the content to the GitHub wiki. So there are three major pages for the three roles.
Admin documentation - https://github.com/sef-global/scholarx/wiki/ScholarX---Admin
Mentor documentation - https://github.com/sef-global/scholarx/wiki/ScholarX---Mentor
Mentee documentation - https://github.com/sef-global/scholarx/wiki/ScholarX---Mentee

Guys, could you please check this and provide feedback?
@EngTeam

1 Like

I think this will do the job! We can improve this later. Good job! @Gajindu_Bandara

Hello Guys! I updated the documentation and made some content and structure changes. could you please check this and provide feedback?. https://github.com/sef-global/scholarx/wiki