Skip to content

User Documentation

smckenziebsu edited this page Apr 18, 2025 · 7 revisions

User Documentation - Goal Tracking Application

Introduction

This guide explains how to use the Goal Tracking Application's features.


Features

1. Add Goal

  • Description: This feature allows you to add a new goal to your tracking list.

  • How to Use:

    1. Enter 1 and press Enter.
    2. You will be prompted to enter the title of your goal.
    3. Type the goal title and press Enter.
    4. The application will confirm that the goal has been added.
  • Example:

    Enter Goal Title: Read a book chapter
    Goal 'Read a book chapter' added.
    

2. Update Goal Progress

  • Description: This feature allows you to update the progress of an existing goal.

  • How to Use:

    1. Enter 2 and press Enter.
    2. The application will display a list of your current goals with their corresponding numbers.
    3. Enter the number of the goal you want to update and press Enter.
    4. You will be prompted to enter the new progress percentage (0-100).
    5. Enter the progress percentage and press Enter.
    6. The application will confirm that the goal's progress has been updated.
  • Example:

    Please Select a Goal to Update:
    1. Read a book chaptter
    Enter goal number: 1
    Enter new progress made (0-100): 50
    Goal 'Read a book chapter' updated.
    

3. Display Goals

  • Description: This feature allows you to display a list of your current goals and their progress.

  • How to Use:

    1. Enter 3 and press Enter.
    2. The application will display a list of your goals, showing their titles and progress percentages.
  • Example:

    Your Goals Are:
    - Read a book chapter (Progress: 50%)
    

4. Display Awards

  • Description: This feature allows you to see the awards you have earned based on the number of goals you have completed.

  • How to Use:

    1. Enter 4 and press Enter.
    2. The application will display the badge you have earned, if any, based on your completed goals.
  • Award System:

    • Bronze Badge: Awarded for completing at least 1 goal.
    • Silver Badge: Awarded for completing at least 3 goals.
    • Gold Badge: Awarded for completing at least 5 goals.
  • Example:

    You have earned the Bronze badge!
    
    You have earned the Gold badge!
    
    You have not earned an award yet, keep going!
    

5. Exit

  • Description: This feature allows you to exit the application.
  • How to Use:
    1. Enter 5 and press Enter.
    2. The application will close.

Clone this wiki locally