Skip to Main Content
Ask A Librarian

Best Practices & Guidelines for LibGuide Authors

This guide provides tips & resources to help WVU librarians create better LibGuides and save time in the process.

Guide
Standards

Standards

These are the standards to consider when creating and maintaining your guides.

  • Tab Naming Convention:
    • Use Title Case when naming tabs for consistency.
  • Guide Naming Conventions
  • External Links Behavior:
    • Retain the default setting: All external links should open in new windows in LibGuides. Do not alter this setting.
  • Friendly URLs:
  • Subject Assignment:
    • Ensure appropriate subjects are assigned to your LibGuide.
  • Credit for Borrowed Content:
    • If you borrow substantial content or replicate another LibGuide, provide credit to the original creator.
  • Enhance Consistency with Common Assets:
    • Duplicate common assets, like Ask-a-Librarian, to ensure consistency and user familiarity. Refer to the instructions in the Common Assets tab for guidance on incorporating assets into your guide.
  • Ensure Brand Consistency:

Profile Box Guidelines

Follow these directions to enhance your profile box:

  1. Front Page Presence:

    • Ensure that every guide includes a profile box on the front page; while optional on other pages, it is recommended for consistency.
  2. Visual Representation:

    • Consider using a recommended photo or an appropriate icon to visually represent yourself.
  3. Contact Information:

    • Include at least one contact method in your profile box.
  4. Chat Widget Caution:

    • If using a chat widget, direct it to your personal IM. Avoid the Ask-a-Librarian widget to prevent user confusion.
  5.  Appointment Widget:
    • Enhance your profile by incorporating an appointment scheduler. Follow these directions to seamlessly integrate it into your profile box.

Design Tips

  1. Text Moderation:

    • Avoid overloading your box with excessive text.
  2. Widget Reusability:

    • Whenever possible, reuse widgets instead of creating new boxes.
  3. Module Selection:

    • Use Link and Database modules for web links or databases instead of HTML/Rich Text.
    • The built-in Link Checker can identify broken links, facilitating easy maintenance.
  4. Link and Database Lists:

    • Discourage lengthy lists of links and databases for a cleaner look.
  5. Page Structure:

    • Avoid creating pages with only one box for improved organization.
  6. Subpage Consideration:

    • Refrain from using subpages as they can complicate navigation.

Guide Type Conventions


Subject Guide

Definition: a guide for a degree-seeking academic department, clinical department, research center, or subject at West Virginia University or other specific patron group that the WVU Libraries serve which provides general guidance and/or resources necessary for performing research in the subject area. 

  • Nomenclature: name of the subject only. Do not include additional language in the name of the guide, including words like guide or research guide. 

    • Example: Psychology 

  • Description: starting point for your research in . Use this guide to locate resources for your field of study. 

  • Tag Suggestions: name of subject 


Course Guide 

Definition: a guide that provides guidance and/or resources to support teaching and research needs of a credit-bearing course at West Virginia University. 

  • Nomenclature: Course Code: Name of Course (as it appears in STAR) 
    • Example: POLS 345: Electoral Systems and Parties 
  • Description: Guidance and resources for students in [Course Code: Name of Course] during the [Fall/Spring] semester of [Year].  
  • Tag Suggestions: course code with section code, semester, year, course instructor name 

Citation Guide  

Definition: A guide that provides guidance and/or resources on citation styles or formats, citation managers, and library instruction or services related to citation. 

  • Nomenclature: name of citation style or citation manager. If possible, refrain from using guide, subject guide, or research guide in the name of the guide. 
  • Types of guides: Citation Guides, Citation Managers, Workshop Instruction
  • Description: This guide is designed to provide [guidance, resources, information] on [topic, tool, etc.] 
  • Tag Suggestions: name of citation style, name of citation manager 

Other Guide 

Definition: A guide that provides guidance and/or resources on a topic, tool, workshop, collection or research area that is not generally considered to be an academic department, program, or credit-bearing course   

  • Nomenclature: name of service or collection. If possible, refrain from using guide, subject guide, or research guide in the name of the guide. 
  • Types of guides: Digitization Lab, Student Lounge, Native American Collections at the WVRHC, , Workshop Instruction
  • Description: This guide is designed to provide [guidance, resources, information] on [topic, tool, collection, etc.] 
  • Tag Suggestions: name of service or collection, location of service or collection