Guide and Step Comments

Note:

The Guide and Step Comments feature and functionality will be removed from the OGL console in OGL 25D.

To support collaboration between multiple OGL developers and or guide reviewers, OGL now provides a comments feature that allows guide reviewers with editor access, to add comments to a guide or to an individual step within a guide. This feature will allow OGL developers and reviewers an efficient way to collaborate on edits and guide status throughout the review and approval process. This incorporates a simple wysiwyg editor.

Examples of potential comments that could be made about an overall guide include:

• "Guide passes testing"
• "I cannot find this guide in the widget"
• "This guide failed testing, see comment on Step 12"
• "We don't use Milestones, so this guide will need to have those steps removed"
• "This guide will need to be expanded upon because we have some custom workflows"

Examples of comments that might be made at the step level include:

• "Please change selector for this step to Personal Information"
• "Guide does not advance after this step"
• "Please insert a smart tip on the date field"
• "Please insert a link to the travel policy in this tip"

Comments can be added, viewed, and edited through the content editor or included when editing in the full editor.

Content Editor

The OGL Editor can now open the Content Editor for a specific guide to review and add comments. When OGL Opens the guide a comment panel will open on the right side of the screen. By default, comments are hidden. To view previously entered comments, click the File Folder icon to the right of the Guide Comment or Step Comment fields.

The OGL Editor has the option to view, edit, delete and add comments at the guide level or add comments for individual steps. Clicking the Comments button at the top right corner of a step in the the "Step Guide" opens the comments panel for that particular step.

To add a new comment the Editor enters the text in the “Write a comment” field and clicks the Green Paper Airplane at the end of the comment field to add the comment to the Guide or Step.

Comments are displayed in date/time order, with the newest comment at the top of the list.

OGL Editors can review all comments added to a guide from the comments panel and use the comments links to view comments related to a specific step. All comments are date, time, and user stamped.

Comments can be edited or deleted from the comments panel.

Once the update has been made to the comment, the OGL Editor clicks the Save button to save the change or Cancel to discard any changes.

To indicate that the issue noted in the guide/step comment has been resolved or that you have taken necessary action, you can select Resolve on the comment as an indication to other administrators.

Full Editor

When an OGL Developer is working with a guide in the Full Editor, step comments are viewed, added, edited or deleted using the new comments button located directly below the text editor for a particular step. (To the right of the camera Icon) Click the comment button to open the comments panel for the selected step.

Select the Edit Comments button to view, add, edit or delete any Step Comments within this step.

To add a new comment, enter your text in the “Write a comment” field and select the Paper Airplane button to add the comment to the step.

Note:

If there are comments available, the Comments button will display the number of comments and they are highlighted in green color

Key Points

• Comment Edit and Delete buttons are only available if the OGL developer or User has the correct permissions
• All comments show the user name of the user who added them and the date that the comment was added. If the date is today's date, then it will show the number of hours since the comment was made
• Comments can be edited and deleted by the creator of the comments
• Users with the Manage Comments permission under the Owners group can edit or delete comments
• Comments remain with the guide for the life of the guide
• Comments are copied with the guide if it is cloned
• When a tip or entire step is deleted, the comments are deleted also., even if the user does not have the Manage Comments permission
• The character limit in all comments is 512 characters
• Each comment creation field includes a character limit counter that dynamically counts down from the character maximum as the user types
• When a user deletes a comment, they are prompted with the following message: “Are you sure that you want to delete this comment?”
• If the user has not seen the guide or step comments, an indicator lets them know that new comments are available