Technical Writing

ProDUCT HELP DOCUMENTATION

Snippet from product knowledge base, sans screenshots

Conversations

The collaboration panel organizes all reviewer comments. To begin, click on the comment icon at the bottom right of the collaboration panel to add a general comment or make an annotation to add more specific feedback. To edit or delete your comments, open the comment action menu by clicking on the three dots in the upper right hand corner of any comment.

You can also interact with other reviewers by simply liking or replying to their comments. Hover over the word Like to see who else has liked that comment. Comments and replies will show grouped together in a conversation thread. Reply to another reviewer’s comment by clicking on the relevant comment in the collaboration panel, adding your reply, and selecting Add Comment to save. The reviewer who authored the comment will receive an email notification and an in-app notification for the newly added reply. After adding a reply, click Back to All Conversations at the top of the collaboration panel to return to all conversations.

While reviewing an annotated asset, clicking on the number next to a markup will highlight that markup on the review canvas and display the associated comment thread in the collaboration panel. Conversely, clicking on a comment thread will highlight the associated markup on the review canvas.

You are also able to view the contact card for anyone who has already commented on an asset by clicking on their name in the conversation panel. When available, this will show their photo, email address and the approval status they assigned to each asset.

@Mentioning

If 'Allow Forwarding' is enabled by the proof uploader, you are able to draw another reviewer’s attention to a particular comment by using @mentioning. When adding a comment, type the @ symbol and a list of invited reviewers for that proof will populate. You can also use this feature to invite new reviewers to the proof by entering an email address after the @ symbol. These reviewers will receive an email and an in-app notification requiring them to review the proof and submit an approval status. The proof owner will also receive an email notification each time a new user is invited to review the proof.

Versioning

This product allows for the Proof Uploader to submit sequential versions of the same document, so that after implementing feedback in their design, these versions will be associated together, and comparable in the review environment. If versions of a proof are available, you can select the View Versions icon located to the right of the proof name in the header. This will open the proof’s version history to the left. Select the version you’d like to reference to open it in a new tab of your browser. The current version indicator is shown to the right of the View Versions icon so that you can quickly view which version is active in your browser window. Previous versions will always show in read-only mode. When a new version of a proof has been uploaded, this will end any active reviews on all previous versions.

ProDUCT HELP VIDEO

Snippet from voiceover for product how-to video

In this video we are going to demonstrate processing and approving work orders. To begin, access your homepage in the product. In the ‘Work Orders by Status’ area, click on the number of New Requests next to the ‘Unassigned’ section. Unassigned simply means that these work orders have been routed to you for approval or review. Think of this as your personal inbox! The work orders next to the label ‘In Approval Process’ are in someone else’s inbox. 

Once you click on the number, you will arrive on the ‘Unprocessed New Requests’ screen. From the main drop down menu, you can choose which new request you would like to process. Once you have selected your request, the page will refresh to reflect the information pertaining to your work order. 

Now, you can make any changes you would like to the work order. For example, you may want to update one of the form items here, such as Location, Craft, Purpose, etc. Normally, when you are processing from this screen, you will want to determine which technician should be assigned the work order. Next to ‘Current Route To,’ you will see your name, verifying that it is currently assigned to you for review. Below that you will see the ‘Assign/Route To’ drop down menu. This is where you will select the next person to  receive the work order. If they are going to complete the work, make sure to leave the ‘Stop Routing’ check box selected. 

To save your selections, simply click ‘Submit’ at the bottom of the page. You can also click ‘Submit and Print’ if you would like to physically print the work order at this time. If you select this option, the work order form will open in an additional tab or browser window. Both options will prompt you to change the status of this work order from ‘New Request’ to ‘Work in Progress’ before proceeding. Hit ‘OK’ to make that change, or Cancel to keep it in the status of ‘New Request.’

Another feature available from this screen is the option to print work orders in a batch, after you have finished processing a group. Before you begin to process a work order, select the option near the top of the page that says ‘Check Here if you want to use Batch Print feature’. One you have selected that option, you will be able to create a new batch for the group of work orders you are about to process. Click on ‘Create New Batch’ and this will provide you will a batch number labeled with today’s date. Now, you will process your work orders normally, and at the bottom of the page, click ‘Submit To Batch.’ Repeat this process until you are done with the remaining new requests. Once you are ready to print the batch, navigate to ‘Shortcuts,’ then, ‘Print Work Order Batch’ and click on the small printer icon next to your batch number. This will print your group of work orders in the same queue.