Skip to Main Content

LibGuide Design: Best Practices and Guidelines

This guide is designed to provide guidance on making LibGuides more useful, accessible, and relevant to users through best practices that incorporate usability and web design.

Detailed Editorial Guidelines

Assign Your Guide to the Right Type and Group

Selecting an appropriate Type and Group for your guide assists users in browsing through guides on the LibGuides home page.

We create and use four Types of LibGuide: Research Guide

  1. If you create a guide for a class to use on a specific assignment or during a specific semester, select the Type "Course Guide" and the Group "Course Guides." 
  2. If you create a guide on a subject, such as Journalism or Biology, or if you create a guide on a subject specifically for researchers in your subject areas, select the Type "Research Guide," and the Group "Research Guides."
  3. If you create a guide about a specific service offered by the WSU Libraries, such as a database or data management resources, select the Type "Library Services and Events" and the Group "Library Services and Events."
  4. If you create a guide about a specific event or an ongoing series of events, select the Type "Library Services and Events" and the Group "Library Services and Events."
  5. If you create a guide about a general issue related to research or library services and include library resources, select the Type "Library Services and Events" and the Group "Library Services and Events."
  6. If you are the Government Documents Librarian and you create a LibGuide specifically about government documents, follow the above guidelines to select the Type you feel is the best match for your guide, then select the Group "Government Documents."
  7. If you are creating a LibGuide for users of the Spokane Academic Library, follow the above guidelines to select the Type you feel is the best match for your guide, then select the Group "Spokane Academic Library."
  8. If you are creating a guide specifically for use by other library employees, select the Type "Internal Guide" and the Group "In-House Library Guide."

Navigation and Layout

  1. Use Side Navigation whenever possible. This navigation style is easier for our users to use, and seems to work better with keyboard navigation (an accessibility plus).
  2. Remember to consider responsive design (how the guide will look screens of different sizes) when placing and ordering boxes on a page.

Titles

  1. LibGuide titles should be clear and concise. The title of your guide should make it easy for users to know what your guide is about before they look at it.
  2. Page titles should also be concise and descriptive.
  3. LibGuide, page and box titles should have Every Major Word Capitalized.

LibGuide URLs

  1. Create a friendly URL to make your guide easier for users to find and remember.
  2. You may create friendly URLs for pages on your LibGuide as well. This is optional, but can be very useful if there is a specific page on your LibGuide that you would like people to link to.

Include Contact Information

  1. Include your profile box on the first page of your LibGuide. This makes it easy for users to contact you if they have questions.
  2. If a LibGuide has multiple authors, include up to but no more than three profile boxes. If a Guide has more than three active authors, indlude a list of contact information on the first page of the LibGuide.

Pages and Subpages

  1. Aim to use fewer than 10 pages on your LibGuide. If you need more than 10 pages, consider breaking your LibGuide into two (or more) guides, especially if you are creating content for a general (undergraduate and/or non-expert) audience.
    • If you have a lot of pages, side navigation makes using your guide easier on your users. Even with side navigation, however, more than 10 pages is usually too much.
  2. Use subpages sparingly. This is especially important if you are using tabs.

Tone and Language

  1. Use a conversational or "business casual" tone in your LibGuide. 
    • It’s ok to address user as “you” and ourselves as “we.” In addition to adding to a friendly tone, personal pronouns are easier to scan and reduce text size.
    • Avoid formal, complex, or academic words when simple ones will do.
    • It's okay to use contractions.
  2. Use the active voice. For example, use "Make an appointment with your librarian..." rather than "Appointments with your librarian may be made..."
  3. Avoid figurative language (idioms, cliches, and slang) which may be difficult for some users to understand.
  4. Avoid unnecessary library jargon.
  5. Use inclusive language and pronouns.

Structure Your Information

  1. Put key information at the top of the page (don’t bury the lead).
  2. Avoid large blocks of uninterrupted text.
  3. Use descriptive headings to structure the information on your page so that users can easily scan and find information.
  4. Use numbered lists to explain sequential steps.
  5. Use bulleted lists to group similar items or to simplify and streamline dense paragraphs.

Fonts, Emphasis, Headings

  1. Use fonts consistently. Using the default font can make your life easier, but if you decide to use another font for your content, make sure you use the same font throughout your LibGuide. Mixing fonts is not generally a good idea for design and accessibility reasons.
  2. Use emphasis sparingly and follow best practices for accessibility. 
    • To make text bold, use <strong></strong> instead of <b></b>. The LibGuides Rich Text editor does this automatically, so you don't need to worry about this unless you are working on the source html of your text.
    • To italicize text, use <em></em> instead of <i></i>. The LibGuides Rich Text editor does this automatically, so you don't need to worry about this unless you are working on the source html of your text.
    • To make text larger, use headings rather than increasing the font size.
    • Don't rely on changing text color to emphasize text. This doesn't work for all users.
  3. When using headings on your LibGuide, use Heading 3 and/or Heading 4. 

Using Assets

Links

  1. If you want to insert a link into your page, do this by using a Link Asset.
  2. Check to see if a Link Asset already exists for the link you want. Re-use existing Assets when possible.

Databases

  1. If you want to link to a database on your page, do this by using a Database Asset.
  2. If the database you want to link to isn't in the Database Assets list, contact Erica Nicol, who can add it for you.

Books

  1. If you want to link to a book in your page, do this by using a Book from the Catalog Asset.
  2. Check to see if a Book from the Catalog Asset already exists for the book you'd like to add. Re-use existing Assets when possible.

Using Images

  1. Include descriptive and appropriate alt text for your images.
  2. Use purely decorative images sparingly. Images can be a great way to add interest to your LibGuide, but they can also distract users.
  3. Avoid clipart and generic stock photographs.
  4. Don't use an image is the subject of the image is just text.

Best Practices LibGuides Checklist

Guidelines Instructions
  Account profile is updated with contact information and an image Your Profile
  LibGuide and page titles are brief, clear, & descriptive Creating a New LibGuide
Customize Your Guide
  Guide type and group assigned
  Friendly URL assigned
  Profile box is added to the guide home page
  Content is thematically chunked into pages and boxes Your Profile
Writing for the Web
Layout
  Guide uses side navigation
  Guide contains no more than 10 pages
  Content (links, books, databases, boxes, etc.) reused when possible
  Boxes are ordered and placed based on responsive design principles
  Guide has been viewed on multiple devices to check responsiveness
  Text written with web consumption in mind: keep it short and simple
  Resource lists are kept short and organized in order of importance
  Consider your users: use plain language and be inclusive when adding content
  Be selective about what to create and be future-friendly
  Use default font with minimal italics and bold and no underlining or ALL CAPS Accessibility
  Start with Heading 3 when you use headers for content structure in rich text editor
  Link text (title) should be descriptive
  Database or links descriptions should display beneath the link title
  All images have alt-text descriptions
  Assign table headers and add caption and summary to describe table (data table only)

 

This checklist is adapted from the Best Practices Guidelines Checklist from the Office of Information Literacy at the University of Illinois at Urbana-Champaign.

The checklist is also available as a PDF:

WSU Libraries, PO Box 645610, Washington State University, Pullman WA 99164-5610, 509-335-9671, Contact Us