Skip to Main Content

Springshare CMS: Tips and best practices for creating a well-designed guide.

This LibGuide provides information about the Springshare products Reference oversees or uses extensively. This Guide provides basic "how-to" information for IOT Library employees using these products.

Tips and best practices for creating a well-designed guide.

1. Think about your audience and THEIR goals

  • Start with a clearly defined subject/topical area for your guide
  • Guide users are often beginners - think about the best way to get them started. Think about what user goals this guide will assist.
  • If needed, have different section for advanced user
  • Think about sharing your guide with actual users for feedback and suggestions

2. Think about and plan arrangement and flow of content

  • Take time to plan out overall structure and content when creating a new guide or review when “adopting” an existing guide.
  • Help users know where to start. Begin with the most important resources or first steps in a process.
  • Avoid defaulting to alphabetical lists.
  • Add context where needed. Something that may be clear to you may not be to someone new to the topic.

3. Voice, tone, & grammar

  • Sound professional, but friendly
  • Use an active voice rather than passive.
  • Use pronouns. The user is You. The library is We. You are I.
  • Avoid jargon and acronyms if possible. Use words a new user would use and understand.

4. Simplify - and then simplify some more

  • Research studies find people on average read 20-28% of a given webpage.
  • Users skim and scan - write clearly and simply. Be concise.
  • A “lean” page is less information for user to navigate - and for you to maintain.

5. Break up/chunk content

  • Chunk content into manageable bits.
  • Avoid long paragraphs of content. Use lists.
  • Break up long lists. Humans don’t do well with long lists. Lists with more than 7 items may not get read.

6. Content styling

  • If you cut and paste from Word, or other documents - be sure to “paste without formatting” - otherwise it can bring in unwanted formatting code.
  • Don’t use all caps, colors, highlights, etc. Stick with the defaults.
  • Don’t use tables unless you really need to. On mobile they often format poorly. 
  • Do use only these default column widths - 1 column, 2 columns: 75/25 or 25/75, or 3 columns: 25/50/25.

7. Parallelism

Our brains are very pattern-oriented. It’s easier to scan lists and headings when ideas and concepts are similar – and/or presented in a similar sentence structure.

Bad example - not using parallelism Good example - using parallelism

Members of the IOT community interested in borrowing library materials not held by the IOT Libraries should contact the Interlibrary Borrowing Service.

Document Services lends original materials owned by the IOT Libraries
to other institutions. It also provides photocopies, including copies of dissertations and theses.
  • If you are a member of the IOT community interested in borrowing materials from other libraries, use our Interlibrary Borrowing Service.
  • If you are not a member of the IOT community and wish to borrow our materials, see our Document Services Department.

8. Tabs

  • Keep tab titles short and parallel.
  • Review your guide on a small screen (or narrow your browser window) and mobile to see how a given number of tabs look.

9. URL naming

Use friendly, shortcut, or persistent links - they are easier to promote and remember.

  • Persistent links - ex: https://search.credoreference.com/browse/research_quick_tip_videos?aid=281203
  • shortcuts URLS on - They won’t break if the real URL changes.
  • “friendly URLS” for libguides -- example: https://iot.libguides.com/BIO100  vs. https://iot.libguides.com/c.php?g=1181234

10. Test in mobile and across devices

  • See how your guide looks on your phone, laptop vs. desktop, etc.