This wiki has undergone a migration to Confluence found Here
<meta name="googlebot" content="noindex">

Difference between revisions of "Template:Volunteer Wanted"

From HL7Wiki
Jump to navigation Jump to search
Line 3: Line 3:
 
NOTE: If you edit the guidance text in this template, be sure to change both the content inside the 'noinclude' tags as well as the content inside the XML comments
 
NOTE: If you edit the guidance text in this template, be sure to change both the content inside the 'noinclude' tags as well as the content inside the XML comments
 
-->
 
-->
−
[[Category:Volunteers Wanted by HL7 Work Group]]<big>To use this Template:
+
[[Category:Volunteer Wanted by HL7 Work Group]]<big>To use this Template:
 
#Search (or Go to) for a page with name like "xxx yyyyyyyy Volunteer Wanted" where
 
#Search (or Go to) for a page with name like "xxx yyyyyyyy Volunteer Wanted" where
 
##'''"xxx"''' is  a Work Group Name or acronym (like "MnM" or "Vocabulary") and
 
##'''"xxx"''' is  a Work Group Name or acronym (like "MnM" or "Vocabulary") and
−
##'''"yyyyyyyy"''' is a functional name like "Data Modeler" or "Project Manager"
+
##'''"yyyyyyyy"''' is a functional title like "Data Modeler" or "Project Manager"
 
##:'''Note:''' The category will sort by title, and this name structure will sort opportunities by Work Group rather than by function.  
 
##:'''Note:''' The category will sort by title, and this name structure will sort opportunities by Work Group rather than by function.  
 
#Click on the '''RED''' link to the (previously) undefined page in order to edit it.
 
#Click on the '''RED''' link to the (previously) undefined page in order to edit it.
Line 26: Line 26:
 
[[:Category:Volunteer Wanted by HL7 Work Group|Return to Help Wanted List]]
 
[[:Category:Volunteer Wanted by HL7 Work Group|Return to Help Wanted List]]
  
−
=Some Artifact Name=
+
=Wanted: <Some functional title>=
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
Artifact names should be descriptive and short. They may change as we further refine the methodology
+
Functional titles should be descriptive and short.
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- Artifact names should be descriptive and short. They may change as we further refine the methodology -->
+
<!-- Functional titles should be descriptive and short. -->
−
TEMPLTE HAS NOT BEEN EDITED FOR HELP WANTED BELOW HERE!!!!
 
  
−
== Definition and Purpose ==
+
==For: <Full Work Group Name of Work Group Seeking the Volunteer>==
 +
== Functional Description ==
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
At a high level, what is this artifact and why is it needed?  Note that according to HL7's [[Annotations Best Practices]] the opening fragment should be a noun phrase rather than a complete sentence. Should ideally be only a few sentences
+
What are the duties, responsibilities, functions that the Work Group wishes a volunteer to perform. This should be a paragraph (at most) of description, recognizing that time and schedule commitments as well as particular domain, technical or tool requirements are listed as sub-headings of this description.
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- At a high level, what is this artifact and why is it needed?  Should ideally be only a few sentences -->
+
<!-- What are the duties, responsibilities, functions that the Work Group wishes a volunteer to perform. This should be a paragraph (at most) of description, recognizing that time and schedule commitments as well as particular domain, technical or tool requirements are listed as sub-headings of this description. -->
  
 
Put text here
 
Put text here
  
−
== SAIF Matrix Location ==
+
===Time Commitment===
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
Where does this artifact fit into the SAIF matrix? Delete those rows and columns that do not apply and provide qualification if appropriate
+
In a phrase, what is the time commitment for this volunteer expected to be? Examples might be "1 hour/week"; "three days per trimester"; "one quarter at each WGM", etc.</i></span></small><br/></noinclude>
−
</i></span></small><br/></noinclude>
+
<!-- In a phrase, what is the time commitment for this volunteer expected to be? Examples might be "1 hour/week"; "three days per trimester"; "one quarter at each WGM", etc. -->
−
<!-- Where does this artifact fit into the SAIF matrix? Delete those rows and columns that do not apply and provide qualification if appropriate -->
 
−
'''Row(s)'''
 
−
* Conceptual (CIM)
 
−
* Logical (PIM)
 
−
* Implementable (PSM)
 
  
−
'''Column(s)'''
+
Put text here
−
* Enterprise/Business
 
−
* Information
 
−
* Computational
 
−
* Engineering
 
−
* Technical
 
  
−
== Prior Methodology Correspondence ==
+
===Commitment Schedule===
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
Identifies how this artifact relates to artifacts from HL7's previous methodology and, in particular, whether there have been changes in scope or behavior from previous artifacts.  In some cases, the artifact will be net new.
+
What is the schedule or frequency of the commitment, such as "every other week", "monthly", "week before WGM", etc.
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- Identifies how this artifact relates to artifacts from HL7's previous methodology and, in particular, whether there have been changes in scope or behavior from previous artifacts.  In some cases, the artifact will be net new. -->
+
<!-- What is the schedule or frequency of the commitment, such as "every other week", "monthly", "week before WGM", etc. -->
  
−
== Audience ==
+
Put text here
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.
 
−
</i></span></small><br/></noinclude>
 
−
<!-- Who will be the consumers of this artifact type and what will they do with it? Select from or add to the following lists.-->
 
−
Health Care Community Audiences:
 
−
*General public <!-- as health care participants -->
 
−
*Health care practitioners <!-- of all stripes -->
 
−
*Health system administrators <!-- includes payors, pharma management -->
 
−
*Health care policy makers
 
−
 
 
−
Health Care Information Technology (IT) Audiences:
 
−
*Standards developers and standards development organizations
 
−
*System designers and architects
 
−
*System purchasers
 
−
*Programmers/implementers
 
−
*System vendor management
 
−
*Education/Research
 
  
−
== Applicability ==
+
===Skill Set required or Desired===
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
Under what circumstances does this artifact type need to be created? Are there circumstances where this artifact should not exist?  Why?
+
Use (edit) the following bullet list as a source, or pattern for defining particular skills that the Work Group expects the volunteer to have or desires that the volunteer have. If the skill is desired but not required, add "(desired)" after the skill listing.
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- Under what circumstances does this artifact type need to be created? Are there circumstances where this artifact should not exist?  Why? -->
+
<!-- Use (edit) the following bullet list as a source, or pattern for defining particular skills that the Work Group expects the volunteer to have or desires that the volunteer have. If the skill is desired but not required, add "(desired)" after the skill listing. -->
−
Text
+
*Domain knowledge of Xyz Domain (Xyz could be a clinical or technical knowledge domain)
−
 
+
*Technical specialty (examples: Data modeling, terminology binding, editing)
−
<i>Rationale</i>: More text
+
*Particular tools capability (examples XSLT Transform writing, Wiki Editing, HL7 RMIM Designer, Publication Database, Project insight, Powerpoint, Excel)
 +
**For tools also include whether you expect the volunteer to be "pre-qualified" or "willing to learn".
 +
*HL7 process and procedure knowledge
 +
* and so on
  
−
== Requirements, Relationships and Content ==
+
===Other Requirements===
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.)
+
Consider and document any other special requirements such as travel required,
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- What are the needs that this particular artifact was created to satisfy and why are those needs important.  (Should not be more than 10-15.) -->
+
<!-- Consider and document any other special requirements such as travel required,
−
# Some requirement
+
-->
−
## <i>Rationale</i>Some reason
+
==Reasons to Choose This Work Group==
−
# Some other requirement
 
−
## <i>Rationale</i>Some other reason
 
−
=== Relationships and traceability ===
 
 
<noinclude><small><span style="color:#0000FF"><i>
 
<noinclude><small><span style="color:#0000FF"><i>
−
What are the other artifacts to which this artifact must or may be required to relate?  (Express those relationships that are "many-to-one" - that is where many of this artifact type will usually relate to one of the other artifact type.) How do they relate? Why is the relationship important? <br/><br/>Follow with a bullet list of artifacts that may or must relate to this artifact, where many of the listed artifact type will relate to one of this artifact type. 
+
If, any, describe any special considerations that might lead a volunteer to select this Work Group. Are there leadership opportunities in the WG? Can the WG provide support to the volunteer's endeavors? Etc?
 
</i></span></small><br/></noinclude>
 
</i></span></small><br/></noinclude>
−
<!-- What are the other artifacts to which this artifact must or may be required to relate?  (Express those relationships that are "many-to-one" - that is where many of this artifact type will usually relate to one of the other artifact type.) How do they relate? Why is the relationship important?
+
<!-- If, any, describe any special considerations that might lead a volunteer to select this Work Group. Are there leadership opportunities in the WG? Can the WG provide support to the volunteer's endeavors? Etc?
−
 
 
−
Follow with a bullet list of artifacts that may or must relate to this artifact, where many of the listed artifact type will relate to one of this artifact type. 
 
 
  -->
 
  -->
−
* Some relationship
 
−
** <i>Rationale</i>: Reason for relationship
 
−
* Some other relationship
 
−
** <i>Rationale</i>: Reason for other relationship
 
−
 
−
<b>Artifact types that may or must relate to this artifact types:</b>
 
−
* Many-related Artifact Type
 
−
* Another Many-related Artifact Type
 
−
 
−
=== Content ===
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What elements or components are required to be part of this artifact, and what is their hierarchical structure?  How?  Why is the content important? (These can be expresses as a hierarchical set of content element names, with a brief phrase to describe each.)
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What elements or components are required to be part of this artifact, and what is their hierarchical structure?  How?  Why is the content important? (These can be expresses as a hierarchical set of content element names, with a brief phrase to describe each.) -->
 
−
* <b>Content element name</b> - Brief Description
 
−
* <b>Another content element name</b> - Brief Description
 
−
** <b>Sub-element name</b> - Brief Description
 
−
* <b>Another content element name</b> - Brief Description
 
−
 
−
== Artifact Technology ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What technological/standard solution has been selected for use in creating this artifact and why?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What technological/standard solution has been selected for use in creating this artifact and why? -->
 
−
Text here
 
−
 
−
=== Rationale ===
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What's the justification for selecting the chosen technology?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What's the justification for selecting the chosen technology? -->
 
−
* Some reason
 
−
* Some other reason
 
−
 
−
=== Alternatives ===
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What other technical solutions might have been possible that were discarded, what did they offer and why were they not chosen? -->
 
−
 
−
<b>Some technology</b>
 
−
* Some pro or con
 
−
* Some other pro or con
 
−
 
−
== Content Constraints ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What are the formal rules about how the artifact can be constructed, including any extensions and constraints based on the selected technology, as well as the rationale for those rules.  These are rules that can reasonably be enforced or validated by tools.
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What are the formal rules about how the artifact can be constructed, including any extensions and constraints for the selected technology as well as the rationale for those rules.  These are rules that can reasonably be enforced or validated by tools. -->
 
−
# Some rule
 
−
## <i>Rationale</i>: Some reason
 
−
# Some other rule
 
−
## <i>Rationale</i>: Some other reason
 
−
 
−
== Content Guidelines ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What are the informal guidelines about the artifact content.  I.e. What constitutes good practice?  These guidelines should be used in the evaluation of artifact instances but generally can't be enforced or validated by tools.
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What are the informal guidelines about how the artifact content.  I.e. What constitutes good practice?  These guidelines should be used in the evaluation of artifact instances but generally can't be enforced or validated by tools. -->
 
−
# Some rule
 
−
## <i>Rationale</i>: Some reason
 
−
# Some other rule
 
−
## <i>Rationale</i>: Some other reason
 
−
 
−
== Publishing Representation(s) ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
How will this artifact be shared and published as part of specifications?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- How will this artifact be shared and published as part of specifications? -->
 
−
# Some text
 
−
## <i>Rationale</i>: Some rationale
 
−
# Some other text
 
−
## <i>Rationale</i>: Some other rationale
 
−
 
−
== Publishing Constraints ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What are the constraints imposed by the publishing process on how artifacts are constructed and submitted to HL7and what are the reasons behind such constraints?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What are the constraints imposed by the publishing process on how artifacts are constructed and submitted to HL7and what are the reasons behind such constraints? -->
 
−
# Some rule
 
−
## <i>Rationale</i>: Some reason
 
−
# Some other rule
 
−
## <i>Rationale</i>: Some other reason
 
−
 
−
== Tooling Considerations ==
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
What tooling features are required or "nice to have" to allow successful development, publication or other use of the artifact?
 
−
</i></span></small><br/></noinclude>
 
−
<!-- What tooling features are required or "nice to have" to allow successful development, publication or other use of the artifact? -->
 
−
# Nice-to-have|Required: Some feature
 
−
## <i>Rationale</i>: Some rationale
 
−
# Nice-to-have|Required: Some other feature
 
−
## <i>Rationale</i>: Some other rationale
 
−
 
−
== Development Process Considerations ==
 
−
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
This section is optional.  It identifies thoughts or guidance around how the artifact will be used.  This may include development process, guidance on how many of this type of artifact are likely to exist within a domain or topic, etc.
 
−
</i></span></small><br/></noinclude>
 
−
<!-- This section is optional.  It identifies thoughts or guidance around how the artifact will be used.  This may include development process, guidance on how many of this type of artifact are likely to exist within a domain or topic, etc. -->
 
−
 
−
# Some text
 
−
## <i>Rationale</i>: Some rationale
 
−
# Some other text
 
−
## <i>Rationale</i>: Some other rationale
 
−
 
−
== Artifact Exchange and Version Management ==
 
−
 
−
<noinclude><small><span style="color:#0000FF"><i>What is the format that will be used to share and exchange "source" representations of this artifact and how will it be managed in source control?</i></span></small><br/></noinclude>
 
−
<!-- What is the format that will be used to share and exchange "source" representations of this artifact and how will it be managed in source control? -->
 
−
 
−
== Authoring and Maintenance Tools ==
 
−
 
−
<noinclude><small><span style="color:#0000FF"><i>What tool or set of alternate tools will be used by HL7 International and recommended for use by others for the development and maintenance of this artifact?</i></span></small><br/></noinclude>
 
−
<!-- What tool or set of alternate tools will be used by HL7 International and recommended for use by others for the development and maintenance of this artifact? -->
 
−
 
−
== Governance Process Considerations ==
 
−
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
This section is optional.  It identifies anticipated or existing governance processes that control or impact the development and adoption of this type of artifact. 
 
−
</i></span></small><br/></noinclude>
 
−
<!-- This section is optional.  It identifies anticipated or existing governance processes that control or impact the development and adoption of this type of artifact.  -->
 
−
 
−
# <b>Governance Process name</b> - Some process description
 
−
## <i>Rationale</i>: Some rationale
 
−
# <b>Another Governance Process name</b> - Process description
 
−
## <i>Rationale</i>: Some other rationale
 
−
 
−
== Issues ==
 
−
 
−
<noinclude><small><span style="color:#0000FF"><i>
 
−
This section is optional. It identifies any outstanding issues (methodology or otherwise) that need to be resolved/answered as part of the guidelines
 
−
</i></span></small><br/></noinclude>
 
−
<!-- This section is optional. It identifies any outstanding issues (methodology or otherwise) that need to be resolved/answered as part of the guidelines -->
 
−
 
−
* Some issue
 
−
* Some other issue
 

Revision as of 03:08, 17 May 2011

To use this Template:

  1. Search (or Go to) for a page with name like "xxx yyyyyyyy Volunteer Wanted" where
    1. "xxx" is a Work Group Name or acronym (like "MnM" or "Vocabulary") and
    2. "yyyyyyyy" is a functional title like "Data Modeler" or "Project Manager"
      Note: The category will sort by title, and this name structure will sort opportunities by Work Group rather than by function.
  2. Click on the RED link to the (previously) undefined page in order to edit it.
  3. Type {{subst::Template:Volunteers Wanted}} as the only content for the new page.
  4. Preview (if desired) to verify the reference was typed correctly
  5. "Save" the page.
    At this point, the contents of this template (with the following exceptions) will replace the substitution link. The exceptions are:
    • These instructions will not appear.
    • The small blue-font annotations about each entry will be replaced with an <!-- XML Comment --> saying the same thing. These comments are visible while editing, but they do not appear when the Wiki page is previewed or saved.
  6. Re-edit the page to include the appropriate content in each of the sections
  7. Save again
The displayed contents below this line is the outline for a help wanted document.

Return to Help Wanted List

Wanted: <Some functional title>

Functional titles should be descriptive and short.

For: <Full Work Group Name of Work Group Seeking the Volunteer>

Functional Description

What are the duties, responsibilities, functions that the Work Group wishes a volunteer to perform. This should be a paragraph (at most) of description, recognizing that time and schedule commitments as well as particular domain, technical or tool requirements are listed as sub-headings of this description.

Put text here

Time Commitment

In a phrase, what is the time commitment for this volunteer expected to be? Examples might be "1 hour/week"; "three days per trimester"; "one quarter at each WGM", etc.

Put text here

Commitment Schedule

What is the schedule or frequency of the commitment, such as "every other week", "monthly", "week before WGM", etc.

Put text here

Skill Set required or Desired

Use (edit) the following bullet list as a source, or pattern for defining particular skills that the Work Group expects the volunteer to have or desires that the volunteer have. If the skill is desired but not required, add "(desired)" after the skill listing.

  • Domain knowledge of Xyz Domain (Xyz could be a clinical or technical knowledge domain)
  • Technical specialty (examples: Data modeling, terminology binding, editing)
  • Particular tools capability (examples XSLT Transform writing, Wiki Editing, HL7 RMIM Designer, Publication Database, Project insight, Powerpoint, Excel)
    • For tools also include whether you expect the volunteer to be "pre-qualified" or "willing to learn".
  • HL7 process and procedure knowledge
  • and so on

Other Requirements

Consider and document any other special requirements such as travel required,

Reasons to Choose This Work Group

If, any, describe any special considerations that might lead a volunteer to select this Work Group. Are there leadership opportunities in the WG? Can the WG provide support to the volunteer's endeavors? Etc?

Retrieved from "https://wiki.hl7.org/w/index.php?title=Template:Volunteer_Wanted&oldid=50531"