Guide to Research Guides: Style Guidelines

1. Less is more - too many search boxes, columns, tabs, links, etc. will overwhelm users
2. Use a one or two column layout
3. Keep side boxes (on the left or right) concise and action-oriented - get more help, chat with a librarian, etc.
4. List the most important resources first
5. Avoid general resources and focus on subject specific resources as much as possible
6. Avoid long lists of links
7. Don’t make the users click more than they need to (i.e. include a sample citation instead of a link to a sample citation)
8. Use the broken link checker once a month to maintain your guide

Text

•  Less is more. Use short segments of text written in a clear, concise style, and put the most important information first.
• Text should be easily scannable. Organize it into bulleted lists when appropriate, and keep paragraphs short and labeled with useful headings.
• Avoid jargon and use simple, familiar words. Even our most expert users may not be native English speakers.
• Use active voice
• Acronyms should always be spelled out the first time they appear on a page
• Follow the Library Web Style Guide for specific Library and University terms

Accessibility considerations for text:

• Use headings - they help screen readers to navigate through text
• Use numbered and bulleted lists - they also help screen readers to navigate
• Bold text is the same as normal text to a screen reader
• Images of text are not readable to a screen reader

Links

• Avoid “click here” or similar phrases that don’t have meaning on their own. Link text must describe where the link goes.
• Do not include an entire URL. Link a word or phrase in your post to the relevant page.
• Good link text:
  • Provides some information when read out of context
  • Uses the minimum amount of text needed to understand where the link leads
  • Doesn’t spell out the full URL
  • e.g. “To see all accessible entrances, view a map of the Daley Library.
• If linking to a document, provide the document format, i.e. Map of the Daley Library (PDF).
• Links should open in the same window (don’t choose the “open in new window” setting).

Accessibility considerations for links:

• Forcing links to open in a new window causes usability and accessibility problems.

Forms

• Form text should be short, concise, easily scannable, and organized into headings
• Just ask for the essential information - nothing more
• Don’t make users enter information that can be auto-filled (date, time, etc.)
• If documents need to be uploaded, indicate the formats accepted (PDF, DOC, etc.)

Accessibility considerations for forms:

• Follow the same guidelines for forms as for text

Images

• Provide text alternatives for media
  • Alt-text for image files
  • Transcripts for video and audio files
• Avoid automatically scrolling images (carousels, slideshows, etc.)
• Avoid automatically playing video and audio
• Avoid images of text

Accessibility considerations for images:

• Images and videos without text descriptions aren’t usable for people with disabilities
• Automatic actions (scrolling, playing audio and video) present usability and accessibility problems
• Images of text are often difficult to read, especially on responsive sites that automatically scale images