Script Comments

Overview

Script Comments allow users to collaborate on script content directly on the Script Builder page within the Mainstay platform.

Users can leave contextual feedback on specific script messages, collaborate asynchronously, track outstanding feedback, and receive email notifications when they are mentioned in a comment.

Comments are organized into comment threads, allowing teams to manage script revisions from initial draft through completion in one place.

Creating a Comment

To leave feedback on a script:

Open the desired script from the 'My Scripts' page.

Navigate to the script message you want to review.

Click Comment. 

Enter your feedback and click the button.

Comment Drafts

If you begin writing a comment but do not submit it, it is automatically saved as a draft. You'll see a preview of your draft as well as a pencil icon indicating you have a draft saved in the comment thread. If you click into the draft, you can continue editing and post your comment.

Drafts are restored if you leave and return to the script using the same browser and device. Drafts remain local to your browser and are not visible to other users until they are submitted.

Navigating the Comments Panel

The Comments panel displays all feedback associated with the current script. You can view the comments panel by clicking the 'Comments' button on the top right hand corner of the script builder.

Once you've opened the comments panel, if there are any comment threads, they will be displayed here. Each script message gets it own comment thread to keep comments organized and focused.

Each comment thread includes:

• A preview of the script message the thread is about
• Comment(s)
• A button to resolve or reopen a thread

Each comment includes:

• Author
• Date created
• Comment content

When adding a comment to a thread or selecting a comment thread, the corresponding script message and comment will be highlighted for you.

Resolving/Reopening Comment Threads

Once the feedback on a particular script message has been addressed, you can resolve the thread by clicking the 'Resolve Thread' button. This will move the thread into the resolved section. Resolved threads remain visible and are not deleted.

If additional work is needed, a resolved thread can be reopened by going into the resolved section, finding the thread you want to reopen, and clicking the 'Reopen' button.

Any time a user resolves or reopens a thread, a thread event is automatically added showing who performed the action and when.

Notifying Users of Your Feedback

Use @ followed by a user's name to notify them that their attention is needed. You can also click the @ in the text box as well. As you type, you'll be shown a list of users available to mention. 'Your Team' indicates non-Mainstay users that have been added to your institution while 'Mainstay Users' indicates Mainstay staff who have access your institution.

Only users with access to your institution can be mentioned.

Mentioned users receive an email notification containing:

• The user who mentioned them
• The script name
• The bot instance's name
• The referenced message
• The comment
• A link back to the script