AuthorsGuide

Back to the course outline

On to the complete Module Review Criteria page

General guidance

• Please use the template
• Please use sentence case for all titles on every page
• As long as all the information mentioned in the template is covered, please feel free to add, subtract or combine body pages of the module as needed; however, keep the References and Resources slide and Other Relevant Modules slides separate so that those materials can be aggregated together when a person uses multiple modules within a single presentation
• If your module runs to 10 slides or more, please contact Ruth and split the module into smaller pieces
• When developing a module please ensure that the contents reflect the ESIP membership. It isn't necessary to cover fields, agencies, etc. that are outside the ESIP family. If a module is specific to a particular group (discipline or agency) the module title needs to reflect that!
• Modules will typically run 5-10 pages in length; but in particular section header modules may be very short
• Module section header and title should be in the upper left corner of every page (in small print)
• If you change the module title, make sure the wiki outline is updated accordingly!

Module cover page

• Please put the name of the module in the "Subtitle" field
• Please put the section header for the module in the "Module Template" field
  • For example, the section header for the NSF data management plan module is Agency requirements
  • For example, the section header for Agency requirements module is "The case for data stewardship"
• Author names and organizations
  • Use Firstname Lastname format for each name (e.g., Joe Smith)
  • Separate first/last name pairs by commas (e.g., Joe Smith, John Doe)
  • If there are multiple organizations indicate that using superscripts
    • For example
      • Joe Smith ¹, John Doe ²
      • 1 OrganizationA
      • 2 OrganizationB
• Version and review date will be updated when the presentation is reviews, so don't bother changing these

Module body pages

• You will have to edit the master slide for the body to include the section header and name of the module - this will update the value on each page (if in doubt about how to do this don't bother as the date and version will be updated when the module is reviewed)
• Appropriate imagery and the use of humor are strongly encouraged? The presentation needs to be accessible and interesting - illustrations that help get the point across are strongly encouraged!

References

• Please list entries in the "References and Resources" slides using the Chicago citation style guidelines

File naming convention

• Please name your module files using the following naming convention:
  • Use camel case (i.e., UseCamelCase) - no underscores, spaces, dashes, etc.
  • Use the form SectionModuleNameAuthor - for example LocalDataManagementManagingYourDataDuerr.pptx

Module Review

When your module is reviewed, here are some of the criteria the reviewers will be using...

• The module should be well-formed (i.e., follow the guidelines above)
• The content is balanced in that it should be concise, yet simultaneously both accurate and complete
• The references should be relevant and any URL's should work
• The content should be geared to a non-expert yet undergraduate or general college level audience
• The content should be simple and understandable by that audience
• Jargon and data management terminology (e.g., data set, granule, etc.) needs to be defined or avoided
• Imagery should be appropriate to the topic and either openly available or appropriately cited

See more complete criteria on the complete Module Review Criteria page.