Using the AI Comment Assistant in the Comment Register

Feature: AI Comment Assistant
Location: Comment Register → AI Assistant button
Purpose: Generate quick, professional report comments based on selected categories and performance levels.

Overview

The AI Comment Assistant helps teachers create brief (1–2 sentence) report comments in seconds. You choose the areas to comment on—Academics, Behavior, Attendance, and/or Punctuality—select the performance level for each, and optionally add keywords (e.g., “improved participation”, “needs to speak to parent”). The system then produces a professional, encouraging, constructive comment and appends the teacher’s first initial + last name in the closing.

Quick Steps

1. Open Comment Register
2. Select the student from the left panel
3. Click AI Assistant
4. Check the categories you want to include
5. Choose a level for each selected category
6. (Optional) Add Additional Keywords
7. Click Generate Comment
8. Review → click Insert to place it into the student’s comment field

How to Access the AI Assistant

1. Go to Comment Register
2. From the student list on the left, click the student you want to comment on
3. Click the AI Assistant button (top action bar)

Tip: The assistant works on the currently selected student. If no student is selected, the assistant can’t generate or insert a comment into the record.

Using the AI Comment Assistant

Inside the AI Assistant window:

1) Select Categories

Choose any combination of:

• Academics
• Behavior
• Attendance
• Punctuality

2) Pick a Performance Level

Each category has its own available levels:

• Academics / Attendance:
  excellent, good, satisfactory, unsatisfactory, needs improvement
• Behavior:
  excellent, good, satisfactory, disruptive, needs improvement
• Punctuality:
  always on time, usually on time, sometimes late, often late, chronically late

3) Add Keywords (Optional)

Use short phrases to guide the comment, for example:

• “improved participation”
• “more consistent homework completion”
• “needs to speak to parent”
• “focus in class”

4) Generate Comment

Click Generate Comment to produce a concise comment matching your selections.

Inserting the Comment into the Register

After generating:

1. Review the AI text
2. Click Insert
3. The comment is placed into the relevant comment field for the selected student and saved.

Note: The AI Assistant is meant to speed up drafting. Teachers can still edit the comment after insertion to match the student’s situation more precisely.

What the AI Produces

The generated comment:

• Uses the student’s first name
• Reflects the selected performance levels (e.g., Academics (Good), Attendance (Satisfactory))
• Includes your optional keywords when provided
• Keeps a professional, constructive tone
• Ends with the teacher’s first initial + last name in the close

Best Practices

• Select only what you want mentioned. Fewer categories = tighter comments.
• Use keywords as short guidance, not long sentences.
• If the comment is close but not perfect, insert and edit—that’s expected.

Troubleshooting

Nothing happens when I click Generate

• Ensure at least one category is checked and a level is selected, or you entered keywords.

“Error: Could not generate a comment.”

• This may be a temporary AI service or network issue. Try again.

“Integration function ‘insertComment’ not found.”

• Refresh the page and retry. If it continues, report it to your system administrator/support team.