The review process for Content Development documentation (word documents)

Please note: the Content Development document templates are being reviewed and the use of confluence of a document management tool is being investigated. This process is for the current documents we use for content development activities.

Reviewers: Certified Consultants, Head of Terminology. The list of Certified Consultants is located: http://www.ihtsdo.org/participate/consultant-terminologist-program 

Coordinator: @Cathy Richardson

Reviews required: 

• Inception phase documents require one reviewer. 

• Elaboration phase and combined documents require two reviews.

  • Review one: 

    • Reviewer is a certified consultant

    • The reviewer reviews the document and advises one of the following outcomes:

      • Signed off 

        • For Consultant program participants sign off by one reviewer will be accepted as signed off for the purposes of the program.

      • Signed off when suggested changes made

      • Requires further work. 

        • Where further work is required, the document will usually require another review by the first reviewer.

  • Review two: 

    • Review is the Head of Terminology

    • The reviewer reviews the document and advises one of the following outcomes:

      • Signed off for construction

      • Signed off for construction when suggested changes made

      • Requires further work. 

• Fast track documents require one reviewer.

1. Document developer:

2. Coordinator: 

• Set up review with an available Reviewer.

• Document who is doing the review in the JIRA issue. 

3. Reviewer: 

• Perform review using the completion criteria located Completion Criteria (under construction). Feedback should be provided using the feedback template located: 

• Provide the feedback to the developer and the coordinator via email. 

• The overall results of the review must be documented within the relevant JIRA issue.  

Note: 

• If unable to do the review, please email the Coordinator as soon as possible so the review can be reassigned. 

• Where feasible, we will look to have the same Consultant/s do the subsequent reviews for the document. 

4. Developer:

• Upon completion of the inception phase documentation:

  • Upload a final version of the document e.g. 1.0, Content Project Tracker Documents ensuring it includes a summary of any review feedback provided and who approved document. 

    • Please follow the guidance on updating document versions: https://confluence.atlassian.com/doc/manage-files-139415.html

  • Change the JIRA issue status to: In elaboration.  

  • Advise Coordinator if this project will be one taken forward to the elaboration phase.
    
    

• Upon completion of the elaboration phase, combined phase or fast track documentation:

  • Upload a final version of the document to Content Project Tracker Documents ,ensuring it includes a summary of any review feedback provided and details of approval e.g. signed off by Head of Terminology.

    •  Please follow the guidance on updating document versions: https://confluence.atlassian.com/doc/manage-files-139415.html

  • If you have approval to author content and will be progressing the JIRA issue liaise with Coordinator on whether further approval e.g. XXXX, Design Authority is required.

    • If Design Authority approval is required, await approval notification.

    • If no Design Authority approval is required

      • move the project to construction in the Content Project Tracker 

      • create the content within the authoring tool

      • notify Coordinator upon completion of authoring work. 

5. Coordinator: 

• Progress documents requiring further approval to XXXX.

• Advise developer of XXXX decision. 

• Where the developer is not an author and the documentation completed the elaboration phase, combined phase or fast track move the JIRA issue to construction and assign to Ian Green for scheduling.