Skip to Main Content

Storage Guide: Best Practices for Creating Guides

Feel free to reuse any of the boxes and/or pages within this guide

Guidelines Checklist

Guidelines

Instructions

 

Account profile was updated with contact information and an image

 

 

Naming conventions followed for both guide title and page titles

 

 

Guide type assigned

 

Guide subjects and tags assigned

 

Friendly URL assigned

 

Library information box is added to the guide home page

 

 

Content is thematically chunked into pages and boxes

 

Content reused when possible (mapped boxes)

 

Boxes are ordered and placed based on responsive design

 

Guide has been viewed on multiple devices to check responsiveness

 

Text written with web consumption in mind: keep it short and simple

 

Resource lists are kept short and organized in order of importance

 

Consider your users: use plain language and be inclusive when adding content

 

Be selective about what to create and be future-friendly

 

Use same font throughout with minimal italics and bold and no underlining or ALL CAPS

 

 

Start with Heading 3 when you use headers for content structure in rich text editor

 

Link text (title) should be descriptive

 

Links should be added using media/widgets, not just underlined text

 

Database or links descriptions should display beneath the link title

 

All images have alt-text descriptions

 

Assign table headers and add caption and summary to describe table (data table only)