From 4d70294f8ab15bc2ca160c3443577799556dc3a8 Mon Sep 17 00:00:00 2001 From: ivan-pelly Date: Sat, 11 Apr 2026 14:04:23 -0700 Subject: [PATCH] Updated the user manual --- docs/um.html | 317 ++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 265 insertions(+), 52 deletions(-) diff --git a/docs/um.html b/docs/um.html index 60e3067..cb1bddc 100644 --- a/docs/um.html +++ b/docs/um.html @@ -291,12 +291,15 @@
  • 2. Accessing the Application
  • 3. Selecting a Program
  • 4. Student Dashboard
    • -
  • 5. Adding a Student
    • -
  • 6. Viewing Student Goals
    • +
  • 5. Adding & Editing Students
    • +
  • 6. Managing Goals
  • 7. Managing Benchmarks
  • 8. Recording Progress Events
    • -
  • 9. Typical Workflow
    • -
  • 10. Usage Notes
    • +
  • 9. Deleting Records
    • +
  • 10. Reports
    • +
  • 11. Mobile Experience
    • +
  • 12. Typical Workflow
    • +
  • 13. Usage Notes

    • @@ -314,6 +317,7 @@ help teachers and program staff organize student progress in a structured way. Users can review assigned students, create or review goals, define benchmarks, and document progress events over time. + The application works on both desktop and mobile devices.

    @@ -330,14 +334,15 @@ Milestones per goal
    - Events - Progress history + Progress Events + Documentation of progress
    - This manual focuses on the current application workflow shown in the - deployed prototype and implemented interface. + This manual covers the current application workflow as implemented + in the deployed prototype. Features relating to district registration + and administration are documented separately.
    @@ -366,12 +371,14 @@

    3. Selecting a Program

    After authentication, the system displays the list of programs - available to the logged-in user. + available to the logged-in user. Each program card shows the + program name, your role (e.g. Teacher, Admin), and whether it is + your primary program.

    1. Review the available program cards.
      2. -
    2. Select WIN Program – Teacher (Primary).
      3. +
    3. Click the program you wish to work in.
    4. The application will open the main dashboard for that program.
    @@ -385,59 +392,115 @@
    -

    Information shown on each student card

    +

    Sidebar

      -
    • Student identifier
      • -
    • Expected graduation date
      • -
    • Number of goals
      • -
    • Number of progress events
      • -
    • Last activity date
      • +
    • + The left sidebar lists all students. Each entry shows the + student's name and IEP date. +
      • +
    • + Use the My Students / All toggle to switch + between viewing only your own students and all students in + the program. +
      • +
    • Click a student to open their goal workspace.

    Navigation

      -
    • The left sidebar lists students for quick access.
      • -
    • Clicking a student opens that student’s detail view.
      • -
    • The dashboard serves as the main starting point for daily use.
      • +
    • + The sidebar also provides links to Reports + and Log Out. +
      • +
    • Click the edit icon next to a student to update their name or IEP date.
    -

    5. Adding a Student

    +

    5. Adding & Editing Students

    - Teachers can add a new student record directly from the dashboard. + Teachers can add a new student record directly from the dashboard, + or edit an existing student's information.

    +

    Adding a student

      -
    1. Click + Add a Student.
      2. -
    2. Enter the Student Identifier.
      3. -
    3. Enter the Expected Graduation Date.
      4. -
    4. Click Add Student to save the record.
      5. +
    5. Click + Add Student at the bottom of the sidebar.
      6. +
    6. Enter the student's Name (initials or other non-personally identifiable label).
      7. +
    7. Enter the Next IEP Date.
      8. +
    8. Click the save button to create the record.

    - Once saved, the new student appears in the dashboard and sidebar. + Once saved, the new student appears in the sidebar immediately.

    + +

    Editing a student

    +
      +
    1. Click the edit icon (pencil) next to a student's name in the sidebar.
      2. +
    2. Update the Name or Next IEP Date as needed.
      3. +
    3. Click Save.
      4. +
    -

    6. Viewing Student Goals

    +

    6. Managing Goals

    - Selecting a student opens the goals view for that student. Goals are - the main tracking objects used to measure student development and - progress. + Selecting a student opens the goal workspace for that student. + Goals are the main tracking objects used to measure student + development and progress. Each goal appears as a tab along the top + of the workspace, labeled by its category.

    -

    Goal details may include

    - +

    Creating a goal

    +
      +
    1. Click the + Goal tab in the workspace.
      2. +
    2. Fill in the goal details: +
        +
      • Category — a short label (e.g. Reading, Math, Behavior)
        • +
      • Baseline — the student's starting point
        • +
      • Goal — a description of the desired outcome
        • +
      • Target Completion Date — automatically pre-filled from the student's next IEP date
        • +
      +
      3. +
    3. Click Add Goal to save.
      4. +
    + +

    Viewing a goal

    +

    + Click a goal tab to view its details. The goal card shows the + category badge, description, and target completion date. Below the + card, two sub-tabs allow switching between + Benchmarks and Progress Events + for that goal. +

    + +

    Editing a goal

    +
      +
    1. Click the edit icon (pencil) on the goal card.
      2. +
    2. Update any of the goal fields.
      3. +
    3. Click Save.
      4. +
    + +

    Closing a goal

    +

    + When a student completes or exits a goal, the goal can be formally + closed from the goal edit screen. +

    +
      +
    1. Click the edit icon (pencil) on the goal card.
      2. +
    2. Set the Close Date.
      3. +
    3. Mark whether the goal was Achieved (yes or no).
      4. +
    4. Optionally add Close Notes summarizing the outcome.
      5. +
    5. Click Save.
      6. +
    +

    + Closed goals remain visible for reference and reporting but are + clearly distinguished from active goals. +

    Users can use this page to quickly review whether a student is making @@ -449,14 +512,31 @@

    7. Managing Benchmarks

    Benchmarks break a goal into smaller, measurable steps. This makes it - easier to see incremental progress over time. + easier to see incremental progress over time. Each benchmark has a + full description and an optional short name used for compact display.

    To add a benchmark

      -
    1. Open the selected student’s goal.
      2. -
    2. Go to the Benchmarks section.
      3. -
    3. Enter the benchmark description.
      4. +
    4. Select the goal tab for the relevant goal.
      5. +
    5. Switch to the Benchmarks sub-tab.
      6. +
    6. Click + Add Benchmark.
      7. +
    7. In the modal, enter the Benchmark description and optionally a Short Name.
      8. +
    8. Click Add to save.
      9. +
    + +

    AI-assisted suggestions

    +

    + When adding a new benchmark, you can click the + ✦ Suggest with AI button. The system will analyze + the student's goal and generate a recommended benchmark that you + can accept, modify, or discard before saving. +

    + +

    Editing a benchmark

    +
      +
    1. Click the edit icon (pencil) next to the benchmark.
      2. +
    2. Update the description or short name.
    3. Click Save.
    @@ -468,16 +548,43 @@

    8. Recording Progress Events

    Progress events document meaningful activities, milestones, or notes - related to a student’s goal. + related to a student's goal.

    -

    Each progress event should capture

    +

    To log a progress event

    +
      +
    1. Select the goal tab for the relevant goal.
      2. +
    2. Switch to the Progress Events sub-tab.
      3. +
    3. Click + Log Progress Event.
      4. +
    4. Enter a Description of the activity.
      5. +
    5. + Optionally, select one or more Related Benchmarks + to link the event to specific milestones. Benchmarks appear as + clickable chips that toggle on and off. +
      6. +
    6. Click Log to save.
      7. +
    + +

    Each progress event captures

      -
    • A brief description of the activity
      • -
    • The user who recorded the event
      • -
    • The date of the event
      • +
    • A description of the activity
      • +
    • The user who recorded the event (recorded automatically)
      • +
    • The date of the event (recorded automatically)
      • +
    • Any linked benchmarks
    +

    + Progress events are displayed in a timeline view, with linked + benchmark tags shown beneath each entry. +

    + +

    Editing a progress event

    +
      +
    1. Click the edit icon (pencil) on the event card in the timeline.
      2. +
    2. Update the description and/or benchmark selections.
      3. +
    3. Click Save.
      4. +
    +

    Example

    Took C4G – loved it!

    @@ -487,8 +594,111 @@
    +
    +

    9. Deleting Records

    +

    + Students, goals, benchmarks, and progress events can all be deleted. + Deletions are permanent and cannot be undone. +

    + +

    How to delete

    + + +
    + Deleting a student or goal is a cascading operation — all child + records (goals, benchmarks, and progress events) are permanently + removed. Use with caution. +
    +
    + +
    +

    10. Reports

    +

    + The Reports section provides tools for extracting and summarizing + student progress data. Access it from the Reports + link in the sidebar. +

    + +

    Student Progress Report

    +

    + Generates a formatted progress report for a selected student over + a date range. This is useful for IEP meetings, program reviews, or + external reporting. +

    + +
      +
    1. Click Reports in the sidebar, then select Student Progress Report.
      2. +
    2. Select a Student from the dropdown.
      3. +
    3. Set the From Date and To Date for the reporting period.
      4. +
    4. Check or uncheck which Goals to Include in the report.
      5. +
    5. + Optionally, edit the Prompt to customize the + report instructions. The prompt auto-saves as you type. +
      6. +
    6. Click Run to generate the report.
      7. +
    + +
    + The generated report aggregates goals, benchmarks, and progress + events into a structured summary that can be copied or used in + external documents. +
    +
    + +
    +

    11. Mobile Experience

    +

    + The application automatically detects whether you are using a + touch-based mobile device and presents a touch-optimized interface. +

    + +

    Mobile capabilities

    + + +
    + Some management features — such as adding students, creating goals, + editing benchmarks, running reports, and deleting records — are + only available in the desktop interface. Use a desktop browser for + full administrative access. +
    +
    +
    -

    9. Typical Workflow

    +

    12. Typical Workflow

    1. Log into the application.
    2. Select the appropriate program.
      3. @@ -496,18 +706,21 @@
    3. Add a student if needed.
    4. Open a student record.
    5. Review or create goals.
      6. -
    6. Add benchmarks to define milestones.
      7. -
    7. Record progress events as the student advances.
      8. +
    8. Add benchmarks to define milestones (use AI suggestions when helpful).
      9. +
    9. Record progress events as the student advances, linking relevant benchmarks.
      10. +
    10. Run reports as needed for IEP meetings or program reviews.
    -

    10. Usage Notes

    +

    13. Usage Notes

    @@ -518,7 +731,7 @@
    - © 2026 WIN Student Goal Tracker + © 2026 WIN Student Goal Tracker.