MyProject V1.4 - User Guide

Provides a url to this user guide for a more comprehensive list and explanation for each command.
Format: help

Checkout a project to begin working on the project immediately.

Format: checkout INDEX

INDEX is the number used to identify the project in the project list.

Example:

If you want to return to the previous view page of the app, simply type the command back.

Format: back

Example:

Once you’re done with using the app, you can use this command to close the app.

Format: exit

Adds a new project into your list of projects.
Format: addProject n/PROJECT_TITLE s/PROJECT_DESCRIPTION

Example:

Adds a person to your contacts. When you add a person to your contacts, it will automatically change to displaying your list of contacts.
Format: add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [t/TAG]…​

Examples:

Unlike other commands, we have implemented this feature to be one of the easies to use. Simply drag a picture over to the panel which the person is at, and the picture will shown as the person’s profile picture in your contacts!

This command is similar to adding a person to your contacts shown previously, except that you have to be checked out into a project, and the person will be added to the working project as well.
Format: addMember n/NAME [p/PHONE_NUMBER] [e/EMAIL] [a/address] [t/tag]…​

However it will be good to add as much information as possible.

Example:

To help you better understand how to use this command, here is a step-by-step guide, using the second example.

Step 1: You type in the addMember command, followed by all the information you want to store, which in this case is her email and also her tag as a friend. With this, before you press enter your screen should look like this:

If your screen looks like the picture above, just press enter and you’re done! Adding a new member is just a simple one step process.

After you press enter you will be able to see the member reflected in the project like this:

And you will also be able to see her in your contacts like this:

If you look closely at Figure 5. you will see that some of the information does not really seem right. That is because you have not input it yet, but don’t worry you can always do that later with our edit command which you will further down the guide.

This command helps to add a person you already saved in your contacts into your project, reducing the need to type his information all over again. All you need to do is enter the index he is listed at.
Format: addFromContacts INDEX…​

INDEX is the number which the person is listed at, and it should be a positive integer eg. 1, 2, 3, …​.

Example:

To help you better understand how to use this command, here is a step-by-step guide.

Step 1. Find the person you want to add, and take note of the index which the person is listed at. Referring to the picture below, let’s say you want to add 'Bernice Yu' into your project. Notice her index is 2.

Step 2. Type in the addFomContacts command with the index 2

Step 3. Press enter and you’re done! Refer to the picture below to see what your screen should look like.

Need to keep track of your team members' schedule? Use this command to record down their timetable easily!

Format:

setTimetable INDEX [n/NUSMODS_SHARE_URL] [f/FILEPATH_TO_TIMETABLE]

Example:

Below is a step-by-step instruction to guide you through the process of setting a timetable to Alex, through the use of NUSMods:

Adds an unchecked task to the list of tasks of your current working project.
Format: addTask s/DESCRIPTION c/dd/MM/yyyy HHmm

Example:

Adds a new project meeting to the current working project.
Format: Format: addProjectMeeting c/ dd/MM/yyyy HHmm s/MEETING_DESCRIPTION

dd/MM/yyyy HHmm refers to the date and time the meeting is to be held.
MEETING_DESCRIPTION refers to the purpose of the meeting.

Example:
Let’s say that you plan to have a meeting on the 19th November 2019, you want to keep track of this meeting by recording it down in the MyProject app.

To add a project meeting:

Edits an existing person in the address book.
Format: edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [t/TAG]…​

Examples:

Edits an existing task in the task list of the current project.
Format: editTask INDEX [s/DESCRIPTION] [c/dd/MM/yyyy HHmm] [d/]

Examples:

Deletes the specified person from your contacts.
Format: delete INDEX

Examples:

Removes the specified person from the current working project.
Format: removeMember INDEX

INDEX refers to the index that the person is listed at under the members section of the project overview.

Example:

To help you better understand how to use this command, here is a step-by-step guide.

Step 1. Find the person you want to remove from the project. Let’s say you want to remove 'Bernice Yu' because she just dropped your module. Notice her index is at 1

Step 2. Type in the removeMember command with the index of 1

Step 3. Press enter and you’re done! She is now no longer a member of your project.

Deletes the specified task from the current working project.
Format: deleteTask INDEX

INDEX is the number used to identify this task in the task list.

Example:

Deletes the specified meeting from the current working project.
Format: deleteMeeting INDEX

INDEX is the number used to identify this meeting in the meeting list.

Example:

Shows you the list of contacts you have currently along with their respective information.
Format: list

See the summary of all budget which shows how much money is left with that budget and where is this budget used.

Format: listBudget

Finds persons whose names contain any of the given keywords.
Format: find KEYWORD [MORE_KEYWORDS]

Examples:

Need to decide on a meeting timing, but having trouble finding a time where all members are free? This command can help suggest meeting timings!

Format: generate d/DURATION [r/TIMERANGE]

Example:

Below is a step-by-step instruction to guide you through generating a meeting timeslot that lasts for at least 1 hours, between Monday 1000 to Monday 1800:

Signs in to the your email account.
Format: signIn ac/ACCOUNT_EMAIL_ADDRESS pa/PASSWORD

ACCOUNT_EMAIL_ADDRESS refers to the sender’s/user’s email address. PASSWORD refers to the password to the sender’s/user’s email address.

Example:

Logs out from your email account.
Format: logOut

Example:

Sends an email to the specified person in your contacts.
Format: sendMail r/RECIPIENT_EMAIL su/SUBJECT me/MESSAGE_BODY

RECIPIENT_EMAIL refers to the email address of the recipients.
SUBJECT refers to the email header.
MESSAGE_BODY refers to the email body.

Example:

Sends an email to all members in the current working project.
Format: broadcastMail su/SUBJECT me/MESSAGE_BODY

SUBJECT refers to the email header.
MESSAGE_BODY refers to the email body.

Example: Let’s say that a new task has just been added and you want to inform your group members of the new task. Instead of switching to another application to inform your group members, you can simply use the broadcastMail command to inform everyone in the group.

To broadcast Email:

Sends a reminder to all members from the current working project of the upcoming Meeting and Task that is due.
Format: sendReminder d/DURATION

DURATION is the number of days from the current time within which the Tasks are due and The Meetings are held.

Example:
Let’s say that you have several meetings and task for the coming week, and you want to remind your group of the upcoming meetings and the tasks that are supposed to be done by the week.

Instead of typing all the meetings and tasks for the coming week all over again, you can just easily send these lists to their email addresses from the application.

To send reminder:

This command sorts the tasks in the task list of the current working project.
Format: sortTask INDEX

INDEX refers to the index of the list provided in the highlighted section above which corresponds to the type of sorting you wish to apply. For example, index 1 corresponds to sorting by alphabetical order. For the case of sorting tasks, only numbers between 1 and 4 are applicable.

Example:

Let’s say you have added many different tasks with different deadlines and progresses into MyProject.

The default sorting order that MyProject offers is by increasing order of time(index 2). However you wish to group those tasks that are done in one group and those not done in another group and then further sort each group by increasing order of time(index 4) to track the progress of your tasks.

Simply type in the command sortTask 4 and all the tasks in the list will immediately be sorted accordingly.

In addition, whenever you add a new task(Section 3.2.4) or edit the details of an existing task(Section 3.3.2), MyProject will automatically insert the newly added or edited task into the correct position based on this new sorting order so you don’t have to continuously type this command whenever you wish to add or edit tasks!

Here is a step by step process on how to do this.

Sorts the spending in the budget list of the current working project based on given specification. The implementation is slightly different from sortTask. MyProject will not show you the list of spending immediately after entering the command sortSpending. Enter the command listBudget to view the newly sorted list of spending.
Format: sortSpending INDEX

INDEX refers to which type of sorting you want to do. In this case, only integers 1, 2 and 5 are applicable.(Refer to the highlighted section above)

Example:

Sorts the meetings in the meeting list of the current working project based on given specification. The implementation is exactly the same as sortTask. Refer to the sortTask section for a more detailed explanation.
Format: sortMeeting INDEX

INDEX refers to which type of sorting you want to do. In this case, only integers 1 and 2 are applicable.(Refer to the highlighted section above)

Example:

Let’s say the organization gave you budgets on equipment and manpower, let’s first add these budgets to the project.

Format: addBudget b/NAME_OF_BUDGET ex/AMOUNT_OF_BUDGET

After adding the budgets, we will be able to see a summary of them at project overview. Currently it only shows the amount remaining which is the same as the amount you typed just now because you haven’t spent anything yet.

Format: addExpense INDEX_OF_BUDGET s/DESCRIPTION ex/AMOUNT SPEND c/dd/MM/yyyy HHmm

One month later…​

Now you have gone through quite a few meetings with the planning committee and made some orders online and receive some invoices, what’s next? To record all these expenses, simply use the command addExpense to add it under the budget. In order to do that, you need the index of the budgets which you may already forgot, but you may simply type listBudgets to view them again.

List information about the budgets.
Format: listBudget

In the diagram below, you are seeing the pie chart representation of the budgets. It will usually show all the expenses made and the amount remaining for this budget. However, if you have already overshot the budget, the pie chart will show overshot instead of remaining to remind you!

After all that have been done, a breakdown of the budget situation will be available at the project overview with a stacked bar graph indicating the amount remaining and the amount spent.

Format: deleteBudget INDEX_OF_BUDGET

Of course you may make a mistake in typing in information about a budget or your sponsors does not want to fund that budget anymore. Simplt type deleteBudget with the index to delete it!

Keeping the planning committee updated regarding budget is always a challenge isn’t it? Fret not, MyProject is here to help! Every update on the budget information will be recorded in an excel sheet located in the budgets folder. It creates a sheet per project and display the budgets and expenses under the budget in a table form. You can easily send this comprehensible document to your team members to update them!

This command allows you to assign a task to one or more of your members in the project.
Format: assignTask TASK_INDEX PERSON_INDEX…​

TASK_INDEX refers to the index at which the task is displayed at.

PERSON_INDEX refers to the index at which the member is displayed at. (You can input more than 1 index)

Example:

To help you better understand how to use this command, here is a step-by-step guide.

Step 1. Find the task you want to assign and the members you want to assign the task to, and take note of their indexes.

Step 2. Type in the assignTask command along with the correct indexes.

Step 3. Press enter and you’re done! You will now see the tasks reflected under the respective members in your contacts.

You will see a success message:

And also see the task reflected under the members:

With the ability to assign task, naturally you should be able to unassign a task as well, and you can do that with this command.
Format: unassignTask PERSON_INDEX TASK_INDEX…​

PERSON_INDEX refers to the index of the person as displayed in your contacts

TASK_INDEX refers to the indexes of the tasks as displayed under the specific person

Example:

To help you better understand how to use this command, here is a step-by-step guide.

Step 1. Identify the tasks you want to unassign and the person you want to unassign the tasks from, and take note of their indexes.

Step 2. Type in the unassignTask command with the relevant inputs

Step 3. Press enter and you’re done!

You will see a success message:

And you will no longer see the tasks reflected under the person.

MyProject also allows you to mark the attendance of one or more members for a meeting.
Format: markAttendance MEETING_INDEX PERSON_INDEX…​

MEETING_INDEX refers to the index of the meeting as displayed in the project overview

PERSON_INDEX refers to the index of the person as displayed in the project overview

Example:

To help you better understand how to use this command, here is a step-by-step guide.

Step 1. Identify the meeting you want to mark attendance for, and the members who were present.

Step 2. Type in the markAttendance command with the relevant inputs.

Step 3. Press enter and you’re done!

You will see a success message:

And the meeting will show up under the information of the person like this:

After assigning the tasks and marking the attendance of members, you can use this command to give you a comprehensive view of how each member is performing within the project isn’t that convenient!
Format: showPerformanceOverview

There are 4 attributes that we calculate for every member which constitutes their performance:

Refer to the pictures below to understand more about how we display this information in a organised manner to you.