Skip to content

Latest commit

 

History

History
433 lines (288 loc) · 10.7 KB

UserGuide.adoc

File metadata and controls

433 lines (288 loc) · 10.7 KB

iGrad - User Guide

1. Introduction

Sick of having tracking your university progress the manual way? Start getting rid of your Excel sheets and scribbled down notes and download iGrad right now!

What is iGrad?

iGrad is the app to track your university progress, for students who are frustrated with the limited features the university provides, by students who are frustrated by the limited features the university provides.

iGrad offers users the ability to create custom courses and graduation requirements, ensuring the maximum degree of flexibility when planning and keeping track of your progress

iGrad also retrieves data directly from NUS Mods, ensuring that module information is always up to date.

iGrad calculates your CAP at every step, ensuring you never have to use a CAP calculator again

Finally, the iGrad team is always open to feedback and suggestions from the public which will always be followed up on.

2. Features

This segment highlights the key features of iGrad.

2.1. Course Builder

iGrad was built with every NUS student in mind. Our custom course builder allows you to build the course of your dreams.

2.2. Modular Credits (MCs) Tracker

We are sick of counting our MCs at the beginning of every semester. Easily see how many MCs you have left in order to apply for graduation.

2.3. Cumulative Average Point (CAP) Tracker

No more googling CAP calculators. iGrad’s CAP tracker keeps track of your CAP at every step and even offers predictive services so you know how well you have to do in order to achieve your dream CAP.

3. Components

This segment contains details on the structure of iGrad.

75425925 9774ff80 597e 11ea 87f5 228f95b5c84f

3.1. Course

A course is simply a group of requirements. It is also how we keep track of your overall CAP and MCs.

3.2. Requirements

A requirement consists of at least one module. Fulfill all modules within a requirement to complete it.

3.3. Modules

A module is the building block of all other components. Mark your modules as done and give it a grade. You can also add optional memos to help you remember why you took the module.

4. How to use this guide

You may proceed to Section 5, “Walkthrough” if you want a step-by-step break down of how to navigate the app, Section 6, “Command List” if you would like to learn how to use each of the commands, and Section 8, “Cheat Sheet” if you would just like a list of all the commands for easy reference.

The figure below explains the symbols used throughout the user guide.

⚠️
Specifies the constraints of the command or situation.
ℹ️
Specifies expected command outcomes.
💡
Specifies extra tips you can use when navigating through our app.

5. Walkthrough

  1. Start up the application

  2. Enter your course details

  3. Key in your graduation requirements

  4. Assign your modules

  5. Mark a module as done

  6. Key in additional details for your modules

  7. Track your MCs

  8. Assign a grade to your module

  9. View your CAP

  10. Export your data

6. Command List

This segment contains a list of commands with examples that you can use to make full use of iGrad.

Take note of the following when using our commands:

⚠️
Commands with fields wrapped within square brackets (i.e. []) require at least one of these fields to be specified when using the command. This means that you need just specify one of these fields while others may be optional based on your usage.

6.1. help

Displays a help message to the user. Lists all possible commands and provides a link to the user guide online.

Command Format

help

Expected Outcome

ℹ️
A popup for the list of all commands as well as the link to the user guide is shown. INSERT POPUP PHOTO

6.2. course

Add, edit or delete your course. Find out how much CAP you need to maintain each semester to achieve your desired CAP.

Command Format

course add n/COURSE_NAME

course edit [n/COURSE_NAME] [u/MCs]

course delete n/COURSE_NAME

course achieve c/DESIRED_CAP s/SEMESTERS_LEFT

Command Sample

Creating a course named "Computer Science"

course add n/Computer Science

Renaming your current course to "Information Systems"

course edit n/Information Systems

Removing your current course

course delete

Calculating the average grade needed to achieve a CAP of 4.50 with 2 semesters left

course achieve c/4.50 s/2

Constraints

⚠️
  1. (all): You can only have at most one course at any one time

  2. course delete: Removing a course deletes all data from the system (including modules, requirements, etc)

Expected Outcome

ℹ️
You should be able to see the added and/or modified course name in the top panel. For delete course, all data would be reset

6.3. requirement

Add, edit or delete a graduation requirement.

Command Format

requirement add n/REQUIREMENT_TITLE u/MCS_REQUIRED

requirement edit REQUIREMENT_CODE [n/NEW_REQUIREMENT_TITLE] [u/NEW_MCS_REQUIRED]

requirement delete REQUIREMENT_CODE

requirement assign REQUIREMENT_CODE [n/MODULE_CODE ...]

Command Sample

Adding a requirement named "Unrestricted Electives" which requires 32 MCs.

requirement add n/Unrestricted Electives u/32

Renaming requirement "Unrestricted Electives" to "Maths and Sciences", and changing the number of MCs required to 20.

requirement edit Unrestricted Electives n/Maths and Sciences u/32

Renaming requirement "Unrestricted Electives" to "Maths and Sciences".

requirement edit Unrestricted Electives n/Maths and Sciences

Changing number of required MCs for requirement "Unrestricted Electives" to 20.

requirement edit Unrestricted Electives u/20

Removing requirement named "Unrestricted Electives".

requirement delete Unrestricted Electives

Assigning modules to requirement.

requirement assign UE0 n/CS1101S n/CS1231S n/CS2030S n/CS2040S

Constraints

⚠️
  1. (all): Requirement names have to be unique.

Expected Outcome

ℹ️
You should be able to see the requirement created and/or edited in the main panel.

6.4. module

Add, edit or delete a module. You would be able to tag (edit) a module with information such as; semester, grade or memo notes information.

Command Format

module add n/MODULE_CODE t/MODULE_TITLE u/MCs [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]

module edit MODULE_CODE [n/MODULE_CODE] [n/MODULE_TITLE] [u/MCs] [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]

module delete MODULE_CODE

module done MODULE_CODE g/GRADE

Note:

⚠️
SEMESTER is specified in format Y_S_ ( e.g. Y1S2 - Year 1 Semester 2 )

Command Sample

Adding the module, CS2103T, with title "Software Engineering" and MCs "4".

module add n/CS2103T t/Software Engineering u/4

Tagging the module, CS1101, with "Y1S2" and grade "A+", and also renaming it to CS1101S.

module edit n/CS1101 n/CS1101S s/Y1S2 g/A+

Tagging the module, ST2234, with "Y2S1" and giving it a memo "pretty easy module".

module edit n/ST2334 s/Y2S1 m/pretty easy module

Removing a module named "CS1101S".

module delete n/CS1101S

Assigning grade 'A' to the module 'CS2103T'.

module done CS2103T g/A

Constraints

⚠️
  1. (module edit) There must be enough MCs left under a graduation requirement (category) for all modules.

  2. (all) The module code (e.g, CS1101S, ST2334), have to be unique

Expected Outcome

ℹ️
You should be able to see the modified module details reflected in the main panel

6.5. export

Exports all data in a (prettified) text file. If information is sufficient, this file can be submitted to NUS as a study plan.

Command Format

export

Expected Outcome

ℹ️
A text file "study_plan.txt" should be generated in the same folder as the iGrad application.

6.6. exit

Exits the program

Command Format

exit

Expected Outcome

ℹ️
The application should exit

7. FAQs

I’m not an NUS student. Can I still use iGrad?

As long as your university follows a similar hierachical structure! However, we will be unable to provide features such as validation from NUSMods.

8. Cheat Sheet

This segment contains all the commands detailed in this guide in a consolidated list.

help

course add n/COURSE_NAME

course edit [n/COURSE_NAME] [u/MCs]

course delete COURSE_NAME

course achieve c/DESIRED_CAP

requirement add n/REQUIREMENT_TITLE u/MCS_REQUIRED

requirement edit REQUIREMENT_CODE [n/REQUIREMENT_TITLE] [u/MCS_REQUIRED]

requirement delete REQUIREMENT_CODE

requirement assign REQUIREMENT_CODE [n/MODULE_CODE …​]

requirement unassign REQUIREMENT_CODE [n/MODULE_CODE …​]

module add n/MODULE_CODE n/MODULE_TITLE u/MCs [n/DESCRIPTION] [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]

module edit MODULE_CODE [n/MODULE_CODE] [n/MODULE_TITLE] [n/DESCRIPTION] [u/MCs] [s/SEMESTER] [g/GRADE] [m/MEMO_NOTES]

module delete MODULE_CODE

module done MODULE_CODE g/GRADE

undo

export

exit

9. Glossary

Terms Definition

Course

A course is the entire programme of studies required to complete a university degree

Graduation requirement

Requirements specified by the university in order for a student to graduate

Module

Each module of study has a unique module code consisting of a two- or three-letter prefix that generally denotes the discipline, and four digits, the first of which indicates the level of the module

Cumulative Average Point (CAP)

The Cumulative Average Point (CAP) is the weighted average grade point of the letter grades of all the modules taken by the students.

Semester

A semester is a part of the academic year. Each semester typically lasts 13 weeks in NUS.

Modular Credits (MCs)

A modular credit (MC) is a unit of the effort, stated in terms of time, expected of a typical student in managing his/her workload.

NUSMods

A timetabling application built for NUS students, by NUS students. Much like this iGrad!

Handy Links