Deliverable Review Instructions for Reviewers

The EMI Deliverable Review procedure requires that appointed reviewers follow the instructions below for reviewing documents:

  1. Reviewers receive an email notification that the deliverable is ready for review from the EMI Project Office
  2. The email notification contains the code and title of the deliverable and the link to the TWiki deliverable page
  3. The TWiki page contains the latest version of the deliverable as a complete and high-quality document in DOC or ODT format
  4. The page also contains links to the TWiki-based review form, one per reviewer
  5. The review form already contains the deliverable and reviewer identification information
  6. The reviewers are requested to update the Review date and fill three sections
    1. The General comments section contains high-level comments on the document and general observation about its structure, completeness status, focus on the right scope, adherence to the deliverable objectives, etc. This section is also used to motivate the rejection of the document in case the reviewer considers it not ready for review
    2. The Additional recommendations section contains optional comments on possible improvements for future versions and other similar observations
    3. The Detailed comments on the content contains a detailed numbered list of items that the reviewer considers critical to be addressed before the deliverable can be approved. The comments must be specific and should allow the authors to clearly identify and address the issues. There can be as many items as necessary, but in case the number of issues is excessive compared to the length of the document, it is suggested to reject the document explaining the reasons in the General comments section. Reviewers and authors can then use the Comments field to discuss the issue. It is recommende to use TWiki signature lines to separate questions and answers. Alternatively, the reviewers can use the change tracking features of their word processing system (in this case it is suggested to use MS Word) to highlight the critical items instead of using the table in TWiki. It is recommended that reviewers and authors agree beforehand on the preferred method.
  7. Reviewers are also encouraged to use the word processor to highlight suggestions and small modifications in the document itself using the tracked changes feature, in order to allow the authors to easily and quickly identify and address minor issues directly in the text
  8. The reviewed document must be attached to the main deliverable page and a link added to the review form
  9. Once the review is complete, the authors reply to the original notification message, informing the EMI PO that the authors can be notified of the availability of the review comments.
Edit | Attach | Watch | Print version | History: r4 < r3 < r2 < r1 | Backlinks | Raw View | WYSIWYG | More topic actions
Topic revision: r4 - 2011-04-19 - unknown
    • Cern Search Icon Cern Search
    • TWiki Search Icon TWiki Search
    • Google Search Icon Google Search

    EMI All webs login

This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
or Ideas, requests, problems regarding TWiki? use Discourse or Send feedback