Difference between revisions of "Resources for Authors/Editors"

Revision as of 11:38, 15 November 2018

This “landing” page provides links useful for IHE Technical Framework Document Authors and Editors.

If you are a first time author, you might want to start with Profile Development Process for First Timers.

Be sure to familiarize yourself with the IHE Wiki. The Wiki Map explains links on the navigation pane to the left of this page.

The links below take you to some useful IHE Wiki pages, Web Pages, ftp sites and Google Sheets.

Inventory of IHE Profiles

The Inventory of IHE Profiles Google Sheet lists all current known profiles, their status (Public Comment, Trial Implementation, Deprecated, etc.) and other relevant information.

Brief Descriptions of Profiles and Their State

The Profiles wiki page provides a brief description of published profiles and an indicator of their state (e.g., final text, trial implementation, public comment, deprecated, etc.)

Publication Schedule Information

The information on the Domain Milestone Dates wiki page is provided by each IHE Domain Planning and Technical Committees.

The IHE Documentation Specialist translates the wiki page information into the detailed publication schedule here. IMPORTANT NOTE: If no information is provided on the wiki, no documents can be scheduled for publication.

A high-level view of the publication status of new IHE profiles is located here.

Official IHE Templates

The official templates for creating IHE Technical Framework Documents are found on the IHE ftp site and are linked to at Official Templates.

This wiki page also contains links to the most recent version of the IHE General Introduction and Shared Appendices found here. The shared appendices include a complete list of IHE Actors, Transactions and Glossary items.

Profile Proposal Process

The Profile Proposal Process wiki page includes an overview of Call for Proposals -> Selecting Short List -> Performing Technical Evaluation -> Final Profile Selection and links to applicable templates.

Writing Technical Frameworks and Supplements

The Writing Technical Frameworks and Supplements wiki page provides some guidelines for authors/editors when developing or updating profiles. It includes the following topics:

Important Note to Authors/Editors
Guidance for Authors and Editors
- Document Templates
- IHE FTP Document Publication Repository - Instructions for Use
Editing Conventions
- Editing in MS-Word
- TF References
The Structure of Technical Frameworks
- Volumes
- Section Numbering
- General Introduction and Shared Appendices
- Revision Numbering Convention

Technical Framework Publication Process

The Technical Framework Publication Process wiki page provides a brief overview of the publication process and the following:

IHE templates (and where to submit comments on them)
Document Stages

Public Comment (and a link to the Public Comment Process)
Trial Implementation
Final Text

Workflow Diagrams (with active links):

New Supplement publication process
Updated Supplements publication process (future)

Document File Naming Conventions
Named Destinations

Where Public Comments Are Located

Among other things, the Public Comment Process wiki page lists where public comments submitted during a public comment period are found.

USE OFFICIAL VERSIONS to update Published Documents

When a document is published (for public comment, trial implementation, etc.) the IHE Documentation Specialist kindly does various cleanup.

When you want to update a published document (e.g. preparing a Trial Implementation draft based on the Public Comment draft, or applying a CP to Final Text), please start by getting the Current Published Word version from IHE ftp site here. Otherwise, if you start from your own version, the IHE Documentation Specialist will have to do all the cleanup and fixes again.

The IHE Document Publication ftp Directory Structure wiki page describes in detail the structure of the Document Publication ftp site.

@@ Line 1: / Line 1: @@
-This “landing” page provides links useful for IHE Technical Framework Document Authors and Editors. It is not intended as a substitute for familiarizing yourself with the complete content of the IHE Wiki. Be sure to see other helpful links on the navigation pane to the left of this page.
+{{TOCright}}
-The links below take you to some useful IHE Wiki pages, Web Pages, ftp sites or Google Sheets.
+This “landing” page provides links useful for IHE Technical Framework Document Authors and Editors.
-__TOC__
+If you are a first time author, you might want to start with '''[[Profile Development Process for First Timers]]'''.
+Be sure to familiarize yourself with the IHE Wiki. The '''[[Wiki Map]]''' explains links on the navigation pane to the left of this page.
+The links below take you to some useful IHE Wiki pages, Web Pages, ftp sites and Google Sheets.
 ==Inventory of IHE Profiles==
 The [https://docs.google.com/spreadsheets/d/1R5aw4hgezmyJpt8eRwk35S6ofu93YU9u03h4LdVOKzI/edit?pli=1#gid=2 Inventory of IHE Profiles Google Sheet] lists all current known profiles, their status (Public Comment, Trial Implementation, Deprecated, etc.) and other relevant information.
+==Brief Descriptions of Profiles and Their State==
+The [https://wiki.ihe.net/index.php/Profiles Profiles] wiki page provides a brief description of published profiles and an indicator of their state (e.g., final text, trial implementation, public comment, deprecated, etc.)
 ==Publication Schedule Information==
-The information on the [[Domain Milestone Dates]] wiki page is provided by each IHE Domain Planning and Technical Committee.
+The information on the [[Domain Milestone Dates]] wiki page is provided by each IHE Domain Planning and Technical Committees.
 The IHE Documentation Specialist translates the wiki page information into the detailed publication schedule [https://docs.google.com/spreadsheets/d/1vjX0lYn4xVEVynpoelvLRe_TzXD5KJ2EyDEQ6WIY0w0/edit#gid=1453845999 here]. '''IMPORTANT NOTE:''' If no information is provided on the wiki, no documents can be scheduled for publication.
+A high-level view of the publication status of new IHE profiles is located [https://www.ihe.net/resources/technical_frameworks/supplement_tracker/ here.]
 ==Official IHE Templates==
-The official templates for creating IHE Technical Framework Documents are found on the IHE ftp site and are linked to at [[Official Templates]].
+The official templates for creating IHE Technical Framework Documents are found on the [ftp://ftp.ihe.net/DocumentPublication/DocumentTemplates/ IHE ftp site] and are linked to at [[Official Templates]].
 This wiki page also contains links to the most recent version of the IHE General Introduction and Shared Appendices found [http://ihe.net/Technical_Frameworks/#GenIntro here]. The shared appendices include a complete list of IHE Actors, Transactions and Glossary items.
 ==Profile Proposal Process==
 The [[Profile Proposal Process]] wiki page includes an overview of '''Call for Proposals -> Selecting Short List -> Performing Technical Evaluation -> Final Profile Selection''' and links to applicable templates.
-==Technical Framework Publication Process==
-The [[Technical Framework Publication Process]] wiki page provides a brief overview of the publication process and the following:
-* IHE templates (and where to submit comments on them)
-* Document Stages
-:* Public Comment (and a link to the [[Public Comment Process]])
-:* Trial Implementation
-:* Final Text
-* Workflow Diagrams (with active links):
-:* New Supplement publication process
-:* Updated Supplements publication process (future)
-*Document File Naming Conventions
-*Named Destinations
 ==Writing Technical Frameworks and Supplements==
@@ Line 56: / Line 46: @@
 **Revision Numbering Convention
+==Technical Framework Publication Process==
+The [[Technical Framework Publication Process]] wiki page provides a brief overview of the publication process and the following:
+* IHE templates (and where to submit comments on them)
+* Document Stages
+:* Public Comment (and a link to the [[Public Comment Process]])
+:* Trial Implementation
+:* Final Text
+* Workflow Diagrams (with active links):
+:* [https://wiki.ihe.net/index.php/Technical_Framework_Publication_Process#Publication_Process_Workflow_Diagrams New Supplement publication process]
+:* Updated Supplements publication process (future)
+*Document File Naming Conventions
+*Named Destinations
+==Where Public Comments Are Located==
+Among other things, the [https://wiki.ihe.net/index.php/Public_Comment_Process#Where_Submitted_Public_Comments_Are_Located Public Comment Process] wiki page lists where public comments submitted during a public comment period are found.
+==USE OFFICIAL VERSIONS to update Published Documents==
+When a document is published (for public comment, trial implementation, etc.) the IHE Documentation Specialist kindly does various cleanup.
-==Location of Published Documents==
+When you want to update a published document (e.g. preparing a Trial Implementation draft based on the Public Comment draft, or applying a CP to Final Text), '''''please''''' start by getting the Current Published Word version from IHE ftp site [ftp://ftp.ihe.net/DocumentPublication/CurrentPublished here.]  Otherwise, if you start from your own version, the IHE Documentation Specialist will have to do all the cleanup and fixes '''again'''.
-All published documents (Word and PDF) are located on the ftp site [ftp://ftp.ihe.net/DocumentPublication/ here.]
 The [http://wiki.ihe.net/index.php/IHE_Document_Publication_ftp_Directory_Structure IHE Document Publication ftp Directory Structure] wiki page describes in detail the structure of the Document Publication ftp site.
+==Some Useful IHE.net Web Pages==
+*[https://www.ihe.net/resources/technical_frameworks/#GenIntro General Introduction and Shared Appendices]
+*[https://www.ihe.net/resources/public_comment/ Technical Framework Public Comment Page]
+*[https://www.ihe.net/resources/technical_frameworks/ Technical Framework Publication Page]
+*[https://www.ihe.net/resources/technical_frameworks/technical_framework_archives/ Technical Framework Archive Page]