Skip to Main Content
Help
Give
Accounts
San José State University Library
SJSU Research Guides
Research Guides
LibGuides How-To Guide
Best Practices Checklist
Search this Guide
Search
LibGuides How-To Guide
Read this before emailing Laurel with questions!
Setting Up a New Guide
Best Practices Checklist
Best Practices Checklist
Accessibility
Integrate Your Guide in Canvas
Adding & Reusing Pages
Profile Boxes
LibCal Appointments Widget
Add Your ORCID ID
Box Types
Box Content Types
Assets List
Adding Databases
Adding Images
Reusing Content
Reusable Content
Guide Maintenance
Adding a Blog Page
Deleting a Guide
FAQs
LibGuides Edit-a-thon 2024
Best Practices Checklists
LibGuides Best Practices Checklist [PDF]
An abbreviated checklist of the most important things to keep in mind when creating or maintaining LibGuides
LibGuides Best Practices Comprehensive Checklist [PDF]
The complete checklist, with references
Best Practices Checklist
Administrative
Give your guides a
friendly URL
Add
Subjects and Tags
to your guides
Include your contact information
Include a photo of yourself in your profile, or at least some kind of image (
some options
)
Integrate your guides with Canvas using Learning Tools Interoperability (LTI)
Accessibility
Use
descriptive link text
— no "click here" links!
Add
alt tags
to images (describe the image for those who cannot see it)
Try to
avoid using tables
Make PDFs accessible for screen readers (see
PDF Accessibility
)
Save
Word, Excel, and other text documents as PDFs
before uploading them, and add "PDF" to the end of the link name.
Make sure video content includes closed captioning or a transcript
When embedding content in an iframe, add a title attribute (see “
Be sure to add titles to iFrames
” for help)
Content
Use as little text as necessary to get the point across
Ensure the text is typo and error free
Use acronyms sparingly and spell them out on the first occurrence.
Avoid library jargon and complex scholarly terminology
For course guides, match the language to the syllabus and align it with course objectives
Add databases using the
Database content type
Reuse content
where possible!
Use small images to reduce load time
Have links to external sites open in new tabs
Assessment & Maintenance
Monitor guide usage by viewing
statistics
Focus on having fewer, high-quality guides that can be effectively maintained
Regularly review and update guides to ensure content remains current and relevant
Use the
Link Checker
occasionally to weed out dead links (or add the
Check My Links browser extension
to your browser for a more reliable link checker!)
<<
Previous:
Setting Up a New Guide
Next:
Accessibility >>