Are you ready for Quality Review?

 

The following steps shall be completed by Technical Authors (or delegate) before submitting a document for Quality Review. Failure to follow these steps will result in the document being immediately passed back for “Quality Review Comment Resolution” and will delay the start of the review.

There are 3 main steps. These are explained in more detail further below.

  1. Ensure that the Document information page is completed correctly.
  2. Ensure that NAA versions are set correctly (DMRB documents only).
  3. Ensure that a version “For approval/authorisation” has been created.

Document information page

All of the actions below need to be completed before submitting the document for Quality Review:

  1. Check the Document reference (DMRB) / Document Number (MCHW) is correct.
  2. Ensure that the Document title does not have any authoring notes included, e.g., a reference to any old document to help identification within CARS.
  3. Ensure that a Summary of the document is provided; separately as an IfS Summary and SHW Summary for MCHW documents. The summary text shall be a brief overview of the purpose of the document and shall not refer to changes made as part of the publication; these are to be included within the release notes.
  4. If superseding an existing document which has different document reference, provide a Legacy Reference (DMRB) / SHW Legacy Reference and IfS Legacy Reference (MCHW). This will be shown on the front page of the exported document(s) as “Formerly […]”. The legacy reference field(s) shall not be used to reference to the previous version of the same document; this is shown within the Release notes section.
  5. Ensure that the correct Category of Change has been selected and the expected version number is displayed within the Provisional next publication version number. Please note that NAA version numbers are separate to the that of the core document and great care must be taken in manging the version numbers of NAAs – please see further below for more information.
  6. Ensure that the Release notes for publication (DMRB) / Release notes for SHW publication and Release notes for IfS publication (MCHW) are completed correctly. Release notes shall only refer to changes made as part of the current update, not retaining any history of previous changes. Release notes shall provide a list of amendments and details of the changes to the current published document.
  7. Ensure the correct options are selected for Documents affected by the next release. If the document does not have NAAs or only the core document has been updated, only select “Core document”. Only select NAA documents if they have been updated as part of the current change. If only NAAs have been updated, then only select those relevant options.
  8. Ensure that the correct Discipline has been selected.
  9. Ensure that the correct Lifecycle Stage has been selected (DMRB documents only).
Back to top

National Application Annexes (NAAs) version numbering (DMRB only)

NAAs have independent version numbers to that of the core document. Each NAA will only have a version number change if that document has been updated. NAA version numbering follows the same semantic structure as used for core documents; i.e., directly linked to the category of change selected for the NAA.

Since NAAs for DMRB documents are published as a single document adjoined to the core document, it is necessary to republish the core document even if only an NAA has been updated. In this situation, the change to the core document is always treated as a Category B. The associated release notes shall indicate which NAAs have been updated and the Documents affected by the next release field shall only have the relevant NAAs selected.

Please ensure that all the above versioning requirements are in place before submitting the document for Quality Review.

Back to top

Version creation “For approval/authorisation”

A “For approval/authorisation” version shall be created before submitting the document for Quality Review. Doing so ensures that the document cannot be modified whilst the review takes place and enables the document to be quickly passed on for approval if there are no quality issues.

Back to top