Proofread

When the reviewer finishes creating or updating a question it will now be submitted for proofreading. 

Proofreading includes the following:

• Spelling check (make sure you have a browser extension like Grammarly installed, it will highlight spelling mistakes)

• Grammar check (the reviewer may not be a native English speaker, so look for any grammatical errors)

• Readability - check that the question reads clearly

• Screenshots - check that the screenshots are readable, clear and have annotations where appropriate. The reviewer should zoom in with the browser to make sure there is not extra space top / bottom / left / right that is not related to what we are trying to explain / show.

It does not include:

• Checking the accuracy of the question / options / explanation

• If something incorrect is spotted when reviewing the question, it can be sent back to the reviewer, but this is not the focus of the proofreading step

These steps describe how to proofread by either returning back the question to the respective reviewer or submit the question for quality check. 

Review Proofread Question - Submit for Quality Check

1. Go to the 'Proofread' tab. Select the desired Assignment then click the 'Review' button.

2. Review the question then modify if there are any changes using the following guidelines:

• UI Question Status*: (Updated for Lightning, UI Independent or Classic Only Feature)

• Screenshot Status*: (Added, Required, Needs Updating and Not Required)

• Question Topic: What is this question about, e.g. Search capabilities available in a Lightning Community. This may have already been provided when the question was assigned. If not, then it needs to be completed.

• Question* (Ensure the question includes 'Choose X answer/s')

• Options* (Ensure there are at least 4 options e.g. A. B. C. D.)

• Answer* (Correct Option Letter)

• Explanation* (Explain why the correct option is correct and why the incorrect options are incorrect)

• Text Highlighter (optional)

• Reference 1: Link to Salesforce help that provides more detail regarding the explanation and correct option

• Reference 2: Optional second link to Salesforce help

• Image 1: Focus on Force screenshot link that provides a visual of the explanation / correct option

• Image 2: Optional second Focus on Force link to provide additional explanation for the explanation

• Image 3: Optional third Focus on Force link

Notes:

• * is a required field. All required fields should be populated.

• A validation message will be displayed if the required fields are empty or not complete.

• Reference and Image links are now clickable.

• Question Notes and Comment history should be displayed ordered by date, with the earliest first. Field displayed in the following order: User, Stage, Date and Notes/Comments.

• Tooltips for the following fields will be available and can be configured if :

  • Question

  • Answer

  • Explanation

  • Reference Link 1

  • Image Link 1

Notes: If a question has been reviewed before and was sent back to the reviewer then submitted for review once again, the previous comments and responses should be displayed as shown below. The reviewer can view the previous comments and responses and verify the changes if applied. 

Also, if there are changes made in the question, a label 'UPDATED' in green highlight will be displayed in each field. (e.g. Question, Options, Answer, etc.)

3.A. Click 'Submit to Quality Check' will submit the question for quality check and remove the assignment from your list. 

Enter the review comments in the pop-up window then click 'Submit' button.

Note: Comment is an optional field.

A notification message stating "Assignment successfully sent to Quality Check!" will be displayed upon submitting to Quality Check. 

3.B.Choose a stage and click the 'Send back to' button to send back the question to the respective reviewer if it needs more work. The question status will then be updated to 'In Progress'. 

Enter the review comments in the pop-up window then click 'Submit' button. Comment is a required field when sending back the question. 

A notification message stating "Assignment successfully sent to Reviewer!" will be displayed upon sending back the question. It will also send an email to notify the creator or the reviewer for the Editor's review comments. 

Review Proofread Question that was sent back by the Reviewer

1. Go to the 'Proofread' tab. Select the desired Assignment then click the 'Review' button.

3. Review the question then modify if there are any changes using the following guidelines:

• UI Question Status*: (Updated for Lightning, UI Independent or Classic Only Feature)

• Screenshot Status*: (Added, Required, Needs Updating and Not Required)

• Question Topic: What is this question about, e.g. Search capabilities available in a Lightning Community. This may have already been provided when the question was assigned. If not, then it needs to be completed.

• Question* (Ensure the question includes 'Choose X answer/s')

• Options* (Ensure there are at least 4 options e.g. A. B. C. D.)

• Answer* (Correct Option Letter)

• Explanation* (Explain why the correct option is correct and why the incorrect options are incorrect)

• Text Highlighter (optional)

• Reference 1: Link to Salesforce help that provides more detail regarding the explanation and correct option

• Reference 2: Optional second link to Salesforce help

• Image 1: Focus on Force screenshot link that provides a visual of the explanation / correct option

• Image 2: Optional second Focus on Force link to provide additional explanation for the explanation

• Image 3: Optional third Focus on Force link

Notes:

• * is a required field. All required fields should be populated.

• A validation message will be displayed if the required fields are empty or not complete.

• Reference and Image links are now clickable.

• Question Notes and Comment history should be displayed ordered by date, with the earliest first. Field displayed in the following order: User, Stage, Date and Notes/Comments.

• Tooltips for the following fields will be available and can be configured if :

  • Question

  • Answer

  • Explanation

  • Reference Link 1

  • Image Link 1