Skip to Main Content

Guidelines for Research Guides

Suggestions for guide creation and maintenance

Get Online Help

Reminder: Online Access

  • Library resources require going through CWRU Single Sign-On.
  • The best method is to follow links from the library website.
  • When logged in and a browser window is not closed, access should continue from resource to resource.
  • Remember to close your browser when done.

Timeline

Timeline Task
Initial setup Review guidelines
Initial setup Select template
Initial setup Determine page structure
Initial setup Check tone
Initial setup Check spelling
Initial setup Review accessibility
Initial setup Preview on multiple devices
Monthly Review link checker
Monthly Add links for new resources
Monthly Fact-check technology guides
Twice Annually Test embedded content: RSS/Twitter Feeds, streaming media, widgets
Twice Annually

Contact faculty - are course guides still needed? (*request an updated syllabus*)

Twice Annually

Check course schedule in SIS; if a course isn't currently offered, make the guide private or unpublished; similarly, archive guides for past events

Twice Annually

Review screenshots and images; update database interfaces and logos
Check copyright compliance for images

 

Twice Annually

Check videos; are video links active? Are vendor-supplied tutorials up to date?
Are the media hosted on the KSL or FC YouTube channels so we can use analytics?

Twice Annually

Check tutorials and update any instructions; are steps and screenshots still current?

Twice Annually

Review usage statistics; how many visits (hits) did your guide(s) get over the prior semester?
For course guides, consider sharing stats with the instructor

Twice Annually

Review widgets; are widgets used where appropriate to ensure that information updates across all guides?

Annually

Review asset list to combine or delete assets if needed

Annually

Review usage statistics to decide which guides should be deleted, combined or made private; can content in low-use guides be added to another guide? Before deleting, export content to HTML and save as PDF

Annually

Review new programs, initiatives, faculty, courses, etc. Do you need to create any new guides to provide library support?

Annually

Remove database links to content that has been canceled

Annually

Review 'subject' guides; does the guide assist the user to learn more about the topic?

Annually

Review 'how to' guides; does the guide assist the user to accomplish a specific action?
Are links provided for guidance?

Annually

Promote guides to relevant audiences; are departments aware of guides and/or updates?

Checklist

Category Explanation
Design: Template Does the guide use an appropriate template?
Design: Boxes Are box headings capitalized?
Design: Contact Does the guide contain an appropriate contact? Is contact info correct?
Design: Audience (subject guides) Does the guide assist the user to learn more about its topic?
Design: Audience (how-to guides) Does the guide assist the user to to accomplish a task?
Are links provided for guidance?
Design: Voice Are directions easy to understand? Is the tone conversational?
Design: Page Structure

Are headings accurate and in correct order so screen readers can follow the page logic?

Properties: Tagging, Subjects, URL Is the guide appropriately labeled and use a friendly URL?
Properties: Accessibility Do colors use contrast? Do images use appropriate alt text? Are videos captioned? Has auto-caption been corrected?
Content: Fact Check Review information for accuracy; update technology procedures
Content: Spell Check Does the guide use correct spelling, grammar, and syntax?
Content: Links Are links up to date?
Content: Screenshots

Are screenshots up-to-date with the current user interface of hardware or software? If not, the guide should be unpublished until it can be updated. Are changes needed for aesthetic or instructional purposes?

Content: Video

Is the video correctly embedded? Does the video reflect the current user interface? Is the information accurate and useful for the guide? Is it supported by other media that explains the information? Are videos hosted on the KSL or FC YouTube channels in order to track analytics?