Skip to Main Content

LibGuides: Best Practice guide: Developing Content

This guide will help you find resources about best practices, tips, and tricks for designing guides.

What's in a Guide?

There are many content elements required to build a complete guide, from describing guide content, to adding subjects and tags, to writing effectively for the web environment. Here are a few tips to keep in mind when building guide content.

Guide Descriptions

Describe your guide to the audience

  • Descriptions are encouraged to clarify focus of the guide 
  • Descriptions should be brief and focused, no more than 1-2 sentences 
  • A general example of a description would be……“This guide will help you find resources about xxxx”

Getting Started

Some tips for getting started with content development

  • Combine guides when 2 or more librarians teach the same class
  • Use an existing guide as a template
  • Use notepad or other text editor to strip background code from word and other documents, when copying and pasting content from outside sources 
  • Consider including resources for learners at both entry and advanced levels
  • Consider providing links to key organizations, professional websites, and journals
  • Offer new resources or examples in the subject area, or more in-depth resources
  • Offer in-depth instructions for using a database that is new or complex
  • Provide resources for writing and citing information, for example link to the OWL at Purdue or other writing site
  • Note what sub-disciplines the database covers, types of materials found in that database

Focus Your Guide

Giving your guide a solid context helps keep learners engaged and on track

  • Guides should serve as a research starting point
  • Class guides should follow learning outcomes and assignments when possible
  • Guide should provide context for your audience
  • Students, distance learners, and public users may have different needs, requirements, and experience
  • Try not to overwhelm users with too much information

Writing Tips

Getting it down in print

  • Writing should be clear, concise and appropriate for subject and audience
  • Make your point in as few words as possible
  • Make it easy for readers to pick out key points
  • Use simple words and sentence structures
  • Try to write one idea per paragraph
  • Don't explain anything that's readily apparent to the user 
  • Avoid exclamation marks, cute phrases, jargon, and puns
  • Use the spellcheck in the text editor  Toggle it on and off with the icon 
  • Spell out acronyms