LibGuides Standards and Best Practices: Structure and Layout
Links
Links to resources should be added as link assets.
- Give each link a description. Shorter descriptions are generally better and in keeping with the goal of less text-heavy guides
- Don't add the EZProxy prefix to the URL. Instead, click the proxy button and the proxy address will automatically be added. If creating links for use outside of LibGuides, you can use the Link Fixer tool.
- Always have the description display beneath item title. Never have it hidden behind a pop up button as this isn't accessible.
- Reuse link assets as often as possible. This makes it easier to batch update.
- Order link lists by relevance, not alphabetically.
- Always link to the specific page that will be needed by the user; refrain from linking to the main page of a large and potentially confusing website.
- Do not add databases as links - instead, use the Database Asset type.
-
Links should make sense if the linked text is read by itself. Screen reader users may choose to read only the links on a webpage. Avoid phrases like “click here” and “more”.
- Unclear link text: Go to this U.S. Government source for comprehensive homeowner data by clicking here.
- Clear link text: The U.S. Government provides comprehensive homeowner data.
Box and Content Order
While LibGuides lets you place boxes in columns and rows, it is important to remember that your boxes will move around!
- Websites with a responsive design make it easy to read content across a variety of devices.
- It allows for interaction without needing to resize or scroll because the content is placed in a flexible grid that changes based on screen size.
- Responsive design also removes the need to design separately for mobile devices since every device is served from a unified design.
How to organize content
- Place your most important content in the left column or top box since this is guaranteed to always be at the top of the guide.
- Break up content so there is a natural flow when the columns are rearranged.
- Group similar or themed content closer together in a column so they don't get separated.
- View your guide on multiple screens (or resize your browser window to activate the responsive design scripts) before publishing.
- Don't use empty columns to take up space.
Naming Conventions
Use these tips for giving a short and descriptive name for pages and content boxes.
- Jargon: avoid library jargon in naming pages. Favor action words.
- Specific Titles: be specific in naming pages. “Encyclopedias” or "Overviews" are more meaningful to students than “Reference Tools”.
- Short Titles: keep page titles short – they should clearly reflect the content in that page.
- Use "and," not "&": Unless the proper name includes an "&"
- Capitalization: use appropriate capitalization.
- Vagueness: Avoid vague terms like "other" or "additional resources".
Homepage
- Better not to title it “Home.” Something like “Getting Started” or "Overview" is better.
- "Start Here" is another good title if your guide walks a user through a process.
For specific naming conventions, see the Naming Conventions section of the Web Style Guide.
Profile Box
The profile box should only be on the Getting Started or Homepage of your guide, in the top right column.
For research or course guides the title of the profile box should read Subject Librarian. Also consider editing the profile box title to refer to your subject specialty: Art Librarian or English Librarian.
Other guides should have a profile box titled Guide Author or Subject Librarian.
The profile box should include
- office address
- email address
- phone number
- photo
You can edit your profile by selecting "LibApps" > "My Profile" from the blue drop-down in the LibGuides dashboard.
Friendly URLs
Friendly URLs make it easy to quickly see and understand the purpose of the page. For example, /g=46515&p=365289 is not intuitive but /libguidesintro/thebasics carries meaning.
- Friendly URLs should be added to all pages.
- Should always be lowercase.
- Use letters, numbers dashes and underscores.
- Don't use spaces! Use either dashes, underscores or combine into one word.
- Limit to one or two words.
The friendly URLs can be set in the following ways:
- Guide: click the pencil next to the URL label
- Page: click the pencil icon in the bordered box next to the Page URL label. This must be set for every page.
Subjects and Tagging
Every guide should be assigned appropriate tags and subjects that specify the content of the guide.
- Without a subject, your guide will not appear in the guide index on the homepage.
- Tagging helps to organize guides and makes them searchable.
- Add tags that are appropriate for the content of your guide.
- New tags can be created but you should also reuse tags as much as possible.
Credits
Adapted from Boston College Library's LibGuides Standards and Best Practices.
- Last Updated: Nov 4, 2022 11:30 AM
- URL: https://libguides.gvsu.edu/libguideshelp