How to use our documents in development tool

Need help using our tool for feeding into College publications? Use our simple 'how to' to understand the best way to manage your comments or view our video tutorial for a guided tour. 

How to use the tool 

To give you more control over your feedback, we recommend drafting comments first rather than publishing them straight away. This is because draft comments can be edited and deleted before publishing.

Once you have published a comment, you will not be able to edit it or delete it.

Add a new comment

You can add a new comment to a consultation in two different places – from the main consultation page where the document is hosted and from your 'My Comments' page.

  1. Select the blue 'Add comment' button. 
  2. On the comment form, fill out the following details: 
    1. Section/Page: you must provide either a page or section number, to denote to the authors where in the document your comment relates to. 
    2. Subsection/Line: to help the authors, please add the specific subsection or line number of your comment where applicable. Where your comment spans multiple lines, please use the first line and use the comment field to specify which lines you are referring to.
    3. Reason for comment: let us know what category your comment falls into – reference, content or spelling/grammar. 
    4. Comment: add the text of your comment here. You have 400 words per comment. 
  3. If you wish to make your comment anonymous to other members (authors will always see your name), tick 'Make my comment anonymous'. 
  4. Select either 'Save draft' or 'Publish comment': 
    1. Save draft will save your comment so you can edit or delete it later on. Other members can't see your draft comments. 
    2. Publish comment will make your comment visible to all members and you will no longer be able to edit it. 

 

Edit a draft comment

To edit a comment, you'll need to navigate to the 'My Comments' page, which is linked from the teal box on the right-hand side of the page where other members comments are listed. 

From this page: 

  1. Navigate to the comment you wish to edit. 
  2. Click the 'Options' button on the right-hand side, next to the comment. 
  3. This will take you to the standard comment form. Make the changes you need to make - you can edit the location, reason for commenting or the comment itself. 
  4. Once you're happy, either click 'Save draft' or 'Publish comment'.

Delete a draft comment

To delete a draft comment, you'll need to navigate to the 'My Comments' page, which is linked from the teal box on the right-hand side of the page where other members comments are listed. 

From this page: 

  1. Navigate to the comment you wish to delete. 
  2. Click the 'Options' button on the right-hand side, and select 'Delete'. 
  3. The tool will ask 'Are you sure you want to delete your comment? Deleted comments are not retrievable.'
  4. If you are certain you want to delete your comment, click 'Delete'. 
  5. Your comment will now no longer be visible under 'Draft comments'. 

Approve a document without comment

If you're happy with the contents of a draft College document and simply want to submit your approval, here's how: 

  1. On the page where the draft document is hosted, click 'Approve without comment'. 
  2. This will remove your ability to comment and agree with other members. 
  3. If you wish to undo your decision, simply click the 'Undo' button. 

 

Agreeing with a comment

To agree with a comment: 

  1. Visit the main page where the draft document is hosted.
  2. Scroll down so you can see the table of comments from other members.
  3. Click the blue 'I agree' text on any of the comments from other members.
  4. Once clicked, you'll see a grey label – as below – saying 'You have agreed with this'. You can click 'Undo' to remove your agreement.  

 

 

Our video tutorial 

Our short video introduction covers how to draft, edit, publish and delete your comments, as well as how to 'agree' with other members and approve a document without comment. 

Ready to add your feedback?

Visit our 'Documents in development' tool to add your comments to key clinical publications.