ITI Editors Guidelines

From IHE Wiki
Jump to navigation Jump to search


To new editors

You have been assigned a document to write for the ITI domain: First of all congratulations and thank you for your help. It might seem frightening at first but we'll do our best to guide you through this experience as painlessly as possible.

These wiki pages will provide you with guidance and advices for editing your document. Should they not be enough, you can always ask experienced ITI members:

  • your mentor (for profiles or white papers);
  • the co-chairs of the ITI committee which will publish the document (most of the time it will be the technical committee);
  • experienced ITI members.


ITI Production cycle

All documents produced by the ITI domain are supporting the ITI production cycle that begins in the early fall by the submission of profile and white paper proposals and ends by the publication of new profiles, new white papers and updated Technical Framework toward the end of the summer of the year after. The following diagram is showing the ITI production cycle in blue and in red the various documents produced by the ITI domain.

ITI Cycle2.JPG


Document types

Each document type has its specificities in terms of content and milesstones that are presented in the following sections

Proposal

TBD

Detailed Proposal

TBD

New profile

Aim of the document


Template


Place in the cycle and milestones


wiki and FTP updates


New White Paper

Aim of the document


Template


Place in the cycle and milestones


wiki and FTP updates


User Handbook

TBD

Updated Technical Framework

TBD

Existing document

TBD

Face to face meetings

Planning face to face meeting

(around October-November)

TBD

First technical face to face meeting of the cycle

(around November-December)

Input:
  • Detail proposal for each proposed new work item (profile or white paper) selected by the planning committee with a list of alternatives for the standards that can be used for the profile and if relevant for the white paper.
Goal:
  • Based on an analysis of the detailed proposals, to define recommandations for the coming cycle in terms of new work items (profiles and white papers).
Output:
  • Written recommandation to the planning committee.


Second technical face to face meeting of the cycle (around January-February)

Input:
  • For each work item (profile or white paper), a document started with the proper IHE template properly applied;
  • For each profile, a rough cut of volume 1;
  • For each white paper, a detailed outline with identification of the name and the future content of each section;
  • For each profile and for each white paper for which it is relevant, a list of alternatives for standards to be used for the profile with strengthes and weaknesses of each alternative.
Goal:
  • For each profile, review of all the use cases and selection of the standards to be used in the profile;
  • For each white paper, review of the outline and if relevant selection of the standards.


Output:
  • For each profile, an action plan to complete volume 1 through calls based on the use cases reviewed during the meeting;
  • For each white paper, an action plan to complete the identified sections through calls.


Third technical face to face meeting of the cycle (around April-May)

Input:
  • For each profile, volume 1 completed (reviewed at least twice by the editorial team prior to the face to face);
  • For each profile, volume 2 fully written (each transaction described, security section written...) and ready to be reviewed by the committee (reviewed at least twice by the editorial team prior to the face to face);
  • For each white paper, draft of the white paper with possible open issues (reviewed at least once by the editoria team prior to the face to face).
Goal:
  • For each profile, review of volume 2 and preparation for public comment publication;
  • For each white paper, review of the draft and preparation for public comment publication.
Output:
  • For each work item (profile or white paper), an approved document to be released for public comment publication possibly pending minor updates to be completed before the release date.

Fourth technical face to face meeting of the cycle (during July)

Input:
  • For each work item (profile or white paper), a complete document updated with resolution from non-controversial comments (possibly done through call(s) with the editorial team);
  • For each work item (profile or white paper), an ordered list of non-resolved comments sorted by priority.
Goal:
  • For each work item (profile or white paper), resolution of comments and preparation for final publication.
Output
  • For each work item (profile or white paper), an approved document to be released for final publication possibly pending minor updates to be completed before the release date.





Return to ITI Technical Committee