UserGuide.adoc

MyProject V1.4 - User Guide

By: T17-1 Since: Oct 2019 Licence: MIT

Content

• 1. Introduction:
• 2. Quick Start:
• 3. Features
  • 3.1. Basic Commands
  • 3.2. Adding Items
  • 3.3. Editing
  • 3.4. Deleting
  • 3.5. Listing Information
  • 3.6. Finding
  • 3.7. Meeting
  • 3.8. Email
  • 3.9. Sorting
  • 3.10. Finance
  • 3.11. Performance tracking

1. Introduction:

MyProject (MP) is for team leaders who prefer to use a desktop app for managing their projects. MP is optimized for those who prefer to work with a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). With MP it is a one-stop app to store and manage your projects and their relevant information, this is especially useful if you are always managing multiple projects across different teams. MP has unique functions such as sending emails to members within the app and financial tracking capabilities etc. Currently our app is optimized for students to use but we intend to expand further to working adults as well.

Interested? Jump to the Section 2, “QuickStart” to get started. Enjoy!

2. Quick Start:

1. Ensure you have Java 11 or above installed in your Computer.

2. Download the latest release here.

3. Copy the file to the folder you want to use as the home folder for MyProject.

4. Type the command in the command box and press Enter to execute it. e.g. typing help and pressing Enter will open the help window.

5. Some example commands you can try:

   1. list : lists all contacts

   2. exit : exits the app

6. Refer to Section 3, “Features” for details of each command.

Warning

Please do not modify the data file or corrupt it in any way. MyProject will not work as intended if you do!

Figure 1. The home page of MyProject listing all the projects you have

3. Features

ℹ️	Parameters enclosed in square brackets[] are optional.

3.1. Basic Commands

Here are some basic commands to start and navigate around the app.

3.1.1. Viewing help: help

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

3.1.2. Checkout a project: checkout

Checkout a project to begin working on the project immediately.

Commands which require a project to be checked out first will be tagged using [Checkout].

Format: checkout INDEX

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

Example:

• checkout 1

3.1.3. Return to previous: back

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

Format: back

Example:

1. checkout 1

2. back

3.1.4. Exiting the app: exit

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

Format: exit

3.2. Adding Items

This section deals with adding information to the application.

3.2.1. Add a project: addProject

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

Example:

• addProject n/CS2103 project s/Software engineering project

3.2.2. Add a person: add

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]…​

💡	A person can have any number of tags (including 0)

Examples:

• add n/John Doe p/98765432 e/[email protected] a/John street, block 123, #01-01

• add n/Betsy Crowe t/friend e/[email protected] a/Newgate Prison p/1234567 t/criminal

3.2.3. Add a profile picture

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!

3.2.4. Add a new member: addMember [Checkout]

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]…​

💡	Adding a member only requires his/her name!

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

Example:

• addMember n/John Doe a/John street, block 123, #01-01

• addMember n/Betsy Crowe e/[email protected] t/friend

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:

Figure 2. AddMemberCommand user input

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:

Figure 3. AddMemberCommand success project overview display

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

Figure 4. New Member displayed in your contacts as a new person added.

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.

3.2.5. Add from your contacts: addFromContacts [Checkout]

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, …​.

💡	You can put multiple indexes to add multiple people to your project at once isn’t that convenient! E.g. addFromContacts 1 3 5

Example:

• addFromContacts 1

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.

Figure 5. Finding the person to add

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

Figure 6. addFromContacts command input.

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

3.2.6. Set a timetable: setTimetable

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

💡	Timetable set can be used to generate available meeting timeslots using the command generate

Format:

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

• Assigns timetable to the person at the specified INDEX.

• The index refers to the index number shown in the displayed person list using the command list.

• The index must be a positive integer 1, 2, 3, …​

Example:

• setTimetable 3 f//home/john/Desktop/aliceTimetable.txt
  Set Alice’s timetable to Alice, who has index 3 in the list of persons.

ℹ️	File should be formatted as a newline separated list of time ranges, e.g: MONDAY 1000 MONDAY 1200 MONDAY 1400 MONDAY 1600 TUESDAY 1100 TUESDAY 1500

• setTimetable 2 n/https://nusmods.com/timetable/sem-1/share?CS2100=LAB:05,TUT:02,LEC:1&CS2101=&CS2103T=LEC:G13&CS2105=TUT:03,LEC:1&CS3241=TUT:05,LEC:1&CS3243=TUT:01,LEC:1&GEQ1000=TUT:D27
  Set timetable to the person with index 2 on the list of persons, by retrieving timetable data from NUSMods.

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

• Step 1: Type list and enter to view the list of persons. Identify the index of the person you wish to set the timetable to.

Figure 7. List of person in the application

• Step 2: Type setTimetable, followed by the index of the person you wish to set the timetable to, and the URL of the share link.

Figure 8. User enters timetable of team member

• Step 3: Press enter, and you would see the following message. You can even scroll down to view a simple visualization of the timetable set!

Figure 9. setTimetable command success

Figure 10. Visualization of timetable set

💡	Even if you accidentally entered a wrong URL, MyProject would prompt you helpfully!

Figure 11. Error message when entered URL is invalid

3.2.7. Add a task: addTask [Checkout]

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

Example:

• addTask s/Finish GUI c/06/10/2019 1600

ℹ️	Whenever you add a time with the prefix c/, the format should be dd/MM/yyyy HHmm e.g 10/12/2019 1600. MyProject will inform you if you attempt to add invalid days such as 30th February.

3.2.8. Add a project meeting: addProjectMeeting [Checkout]

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:

1. Type addProjectMeeting c/19/11/2019 1300 s/Discussion on version 2 and press enter to execute it.Note that this project meeting will be held after the 4th meeting on 16/11/2019 1700 and before the 5th meeting on 29/11/2019 1300.

2. Success message with the respective information about the meeting will be displayed. The meeting added will be automatically sorted according to the dates and times in ascending order. Thus, the new meeting added will be placed as number 5.

3.3. Editing

This section deals with editing information shown on the application.

3.3.1. Edit a person : edit

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

• Edits the person at the specified INDEX. The index refers to the index number shown in the displayed person list. The index must be a positive integer 1, 2, 3, …​

• At least one of the optional fields must be provided.

• Existing values will be updated to the input values.

• When editing tags, the existing tags of the person will be removed i.e adding of tags is not cumulative.

• You can remove all the person’s tags by typing t/ without specifying any tags after it.

Examples:

• edit 1 p/91234567 e/[email protected]
  Edits the phone number and email address of the 1st person to be 91234567 and [email protected] respectively.

• edit 2 n/Betsy Crower t/
  Edits the name of the 2nd person to be Betsy Crower and clears all existing tags.

3.3.2. Edit a task : editTask [Checkout]

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

• Edits the task at the specified INDEX. The index refers to the index number shown in the displayed task list. The index must be a positive integer 1, 2, 3, …​

• If d/ is not provided in the input, the task will automatically be unchecked.

• Existing values will be updated to the input values.

Examples:

• editTask 1 c/05/05/2019 1600 d/
  Edits the date and time to 05/05/2019 1600 and checks the task.

• editTask 2
  Unchecks the task.

3.4. Deleting

This section deals with removing information within the application.

3.4.1. Deleting a person: delete

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

• Deletes the person at the specified INDEX.

• The index refers to the index number shown in the displayed person list.

• The index must be a positive integer 1, 2, 3, …​

Examples:

• list
delete 2
  Deletes the 2nd person in the address book.

• find Betsy
delete 1
  Deletes the 1st person in the results of the find command.

3.4.2. Remove a member: removeMember [Checkout]

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:

• removeMember 1

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

Figure 12. Finding the person you want to remove

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

Figure 13. removeMember command user input.

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

3.4.3. Delete a task: deleteTask [Checkout]

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:

• deleteTask 1

3.4.4. Delete a meeting: deleteMeeting [Checkout]

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:

• deleteMeeting 1

3.5. Listing Information

3.5.1. List your contacts: list

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

3.5.2. List your budgets: listBudget [Checkout]

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

Format: listBudget

Figure 14. Present budget in a pie chart depicting all expenses under the budget and the remaining amount.

3.6. Finding

3.6.1. Find a person by name: find

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

• The search is case insensitive. e.g hans will match Hans

• The order of the keywords does not matter. e.g. Hans Bo will match Bo Hans

• Only the name is searched.

• Only full words will be matched e.g. Han will not match Hans

• Persons matching at least one keyword will be returned (i.e. OR search). e.g. Hans Bo will return Hans Gruber, Bo Yang

Examples:

• find John
  Returns john and John Doe

• find Betsy Tim John
  Returns any person having names Betsy, Tim, or John

3.7. Meeting

For every project, you can add meetings to it, and below you will be able to find more useful commands associated with this functionality.

3.7.1. Generate meeting timing: generate [Checkout]

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!

• Prerequisite:

  • Members have been assigned to the project using addFromContacts or addMember

  • Timetables have been assigned to the members with the command setTimetable

ℹ️	generate would not give an error if some members do not have timetable assigned to them. Ensure that you have done setTimetable for each of the members in the project before using generate.

Format: generate d/DURATION [r/TIMERANGE]

Example:

• generate d/2 r/MONDAY 0900 MONDAY 1800
  Generates all possible meeting timeslots that lasts at least 2 hours, within the time frame of Monday 9am to Monday 6pm.

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:

• Step 1: To generate a meeting timing for a project, you first need to checkout that project.

Figure 15. Timeslot will be generated for the checked out project

• Step 2: Enter the command with your desired duration of the meeting, and the time range to generate within

Figure 16. Enter parameters for generate command

• Step 3: Press enter, and you will see the following result:

Figure 17. Suggested timeslots shown on the GUI

ℹ️	If MyProject is unable to find a timeslot where all members are free, it would try to find another timeslot where most members are free

Figure 18. Result shown when not all members are available. Members available would be listed.

3.8. Email

Tired of switching between applications? We got you covered, below you will find some commands which support sending emails right here within the application.

ℹ️	Do keep in mind that the user Account in our current version is only compatible with Gmail Account and please ensure that the Access to less secure app in the security setting is enabled before signing in!

3.8.1. Sign in to your account: signIn

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:

• signIn ac/[email protected] pa/12345678

Important

Please Turn on the access to less secure app in your account’s security setting.

ℹ️	This command is required to be executed before the remainder of the email commands can be executed. The correctness of the email address used and the password will be checked.

3.8.2. Log out from your account: logOut

Logs out from your email account.
Format: logOut

Example:

• logOut

3.8.3. Send an email: sendMail

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:

• sendMail r/[email protected] su/Test me/HelloWorld!

ℹ️	We will not check the correctness of the person’s email address

3.8.4. Broadcast an email: broadcastMail [Checkout]

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:

1. Type broadcastMail su/New Task Added me/Finalise UG and DG before 17th November and press enter to execute it. Note that the SUBJECT will be sent as the email header and the MESSAGE_BODY will be sent as the email body.

2. A success message will be displayed in the box saying "Mail have been sent successfully!"

3. Members will receive the email that looks like the following:

ℹ️	We will not check the correctness of the members' email addresses

3.8.5. Send reminder: sendReminder [Checkout]

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:

1. Type sendReminder d/7 and press enter to execute it.Note that the date at the time this screenshot was taken is 10/11/2019, thus, only meeting meetings 2-4 and task 1-3 will be sent as reminders to the members.

2. A success message will be displayed in the box saying "Reminders have been sent!"

3. Members will receive an email with the tasks due and meetings happening within the next 7 days.

ℹ️	We will not check the correctness of the members' email addresses

3.9. Sorting

The following section provides a set of commands which help with sorting the information inside the application. MyProject makes it very easy and user-friendly by making all sort commands follow the same format and index/order pairing as shown below!

All commands in this section follow this set of index/order pairing, where applicable:

1. Alphabetical order

2. Increasing order of time

3. Whether tasks are done

4. Whether tasks are done and then by increasing order of time

5. Increasing price

ℹ️	The default sorting order for the following lists is by increasing order of time(index 2). Whenever MyProject is closed, the ordering will return to the default order.

3.9.1. Sort tasks: sortTask [Checkout]

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.

1. Firstly, since this command is labeled with [Checkout] at the start, ensure that you checkout to a project first. Notice how the tasks in the task list are currently at the default sorting order which is by increasing order of time.

2. Next, enter the command sortTask 4 into the command line and press enter. You can choose any index from 1-4 depending on which type of sorting order you wish to sort by based on the specifications provided in the highlighted section above.

3. The following success message will be displayed if the input was entered correctly. Check that the type of sorting displayed in the success message is the one you actually wanted.
   The tasks in the task list will then be immediately sorted accordingly as shown in the white box.

4. Now let’s say the deadline for task 2(Do UG) is pushed forward by a week and you’ve just completed it. Type in the command editTask 2 d/ c/04/12/2019 0000(check out section 3.3.2 for more details on the editTask command) into the command line and press enter.
   The task will be edited accordingly and immediately be sorted into the correct position as shown below.

3.9.2. Sort spending: sortSpending [Checkout]

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:

• sortSpending 5 (Sorts the spending by increasing prices)

3.9.3. Sort meeting: sortMeeting [Checkout]

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:

• sortMeeting 1 (Sorts the meetings by alphabetical order)

3.10. Finance

Imagine today you just attended the Budget meeting and your Organization is kind enough to provide you with budgets for your event! How delightful! What’s better is that you can record this information in MyProject!

3.10.1. Add budget: addBudget [Checkout]

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.

3.10.2. Add expense: addExpense [Checkout]

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.

3.10.3. List budgets: listBudget [Checkout]

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.

3.10.4. Delete Budget

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!

3.10.5. Excel sheet storage

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!

3.11. Performance tracking

Knowing that it is hard to keep track of what every needs to do, or has done so far, MyProject gives you a simple way of tracking the performance of each member as well. The following section will give you all the details you need to know about this feature.

3.11.1. Assigning a task: assignTask [Checkout]

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:

• assignTask 1 1

💡	You can assign a task to multiple people easily just by including all of their indexes E.g. assignTask 1 1 3 5 this assigns task 1 to member 1,3 and 5.

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.

Figure 19. Finding the task to assign and the members to assign to

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

Figure 20. Typing the assignTask command with the correct input

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:

Figure 21. assignTask command success message

And also see the task reflected under the members:

Figure 22. How the assigned task is shown

3.11.2. Unassigning a task: unassignTask

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:

• unassignTask 1 1

💡	You can unassign one or more tasks at once from a person by specifying all the task indexes. E.g. unassignTask 1 1 3 5 this unassigns tasks 1, 3, and 5 from the first person.

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.

Figure 23. Finding the tasks to unassign, and the person to unassign the tasks from.

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

Figure 24. unassignTask command input

Step 3. Press enter and you’re done!

You will see a success message:

Figure 25. unassignTask command success message

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

3.11.3. Mark attendance: markAttendance [Checkout]

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:

• markAttendance 1 1

💡	You can mark the attendance of multiple people at once, just by specifying all the indexes of the persons E.g. markAttendance 1 1 3 4 this marks the attendance for meeting 1 for members 1, 3 and 4.

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.

Figure 26. Finding the meeting to mark attendance for and the members to mark attendance of

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

Figure 27. markAttendance command input

Step 3. Press enter and you’re done!

You will see a success message:

Figure 28. markAttendance command success message

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

Figure 29. Showing attendance marked

3.11.4. Viewing performance overview: showPerformanceOverview

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:

1. Number of tasks completed

2. Percentage of assigned tasks completed (Rate of task completion)

3. Number of meetings attended

4. Percentage of total number of meetings attended (Rate of attendance)

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

• Table showing the number of task each member completed:

• Table showing the percentage of their assigned tasks each member completed:

• Table showing the number of meetings each member attended:

• Table showing the percentage of the total number of meetings each member attended:

• Lastly you can also view each member individually after scrolling through the tables: